Generate Documentation from Source Context

You can use Atloria to generate documentation from the source context that has been analyzed for your project. This helps you create up-to-date technical content that reflects the project’s components, relationships, data layers, and configuration.

Overview

Atloria organizes analyzed project context into documentation-oriented categories, such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. When you generate documentation, Atloria uses this available context to produce a documentation version based on the current project information.

Use this feature when you need to create an initial set of technical documentation, refresh content after the project changes, or produce another generated version for review. The generated content can describe how parts of the product relate to one another, such as components that render other components, services that call APIs, or code that depends on another service.

The Technical Docs area is intended for technical content created from project-source context. If you need end-user instructions instead, use the User Docs or User Guides area where available.

📷 Screenshot pending: The Technical Docs screen showing source context and documentation generation actions.

Prerequisites

Before you begin, make sure that:

• You can open the relevant project in Atloria.
• Your project source has been analyzed so that source context is available.
• You have access to the project’s Technical Docs area.
• You know whether you are creating technical documentation or end-user documentation.
• You have reviewed the available source context if you need to verify what Atloria will use for generation.
• You are ready to review generated content before sharing it with others.

Step-by-Step Instructions

1. Open the project for which you want to create documentation.

2. Select Technical Docs to open the project’s technical documentation workspace.

3. Click View Source if you want to inspect the source context before generating documentation.

4. Review the available source information to confirm that it represents the parts of the project you want documented.

5. Return to the documentation workspace after reviewing the source context.

6. Select the available documentation style using the style selector, if a style option is shown.

7. Click Generate More to create additional documentation from the available source context.

8. Wait for Atloria to finish creating the generated documentation version.

9. Review the generated documentation for accuracy, completeness, and terminology that matches your organization’s standards.

10. Click Regenerate Docs if you want Atloria to create a replacement documentation result using the current source context.

11. Click ↻ Re-generate when you want to refresh an existing generated result.

12. Click ✦ Regenerate AI docs when you want to regenerate AI-produced documentation from the project information.

13. Click Source when you need to return to the source-oriented view while reviewing generated content.

14. Select User Docs or User Guides if the content should be rewritten as instructions for product users rather than technical documentation.

📷 Screenshot pending: The source review view opened from the View Source action before documentation is generated.

Tips and Best Practices

• Generate technical documentation only after the relevant project context has been analyzed. Atloria can use information across frontend, backend, database, API schema, configuration, documentation, and infrastructure areas, so more complete source context generally produces more useful results.

• Review source context before generation when the documentation must cover a specific feature or system area. Selecting View Source helps you validate that the material available to Atloria includes the items you expect.

• Use regeneration deliberately. Regenerate Docs, ↻ Re-generate, and ✦ Regenerate AI docs can create a new result from the current project context. Review the new version carefully, especially after source changes or analysis updates.

• Keep technical and user-facing content separate. Use Technical Docs for implementation-oriented material, such as component relationships, services, APIs, data access, and configuration. Use User Docs or User Guides for task-focused instructions written for people using the product.

• Check relationship descriptions for clarity. Generated content may describe relationships such as one component rendering another, a component using a hook or context, a service calling an API, or a repository querying a model. Confirm that these descriptions are useful for your intended readers.

• Treat generated content as a draft for review. Ensure names, product terminology, security guidance, and operational instructions meet your team’s publishing standards before distributing the documentation.

Related Pages

• View Technical Documentation
• Review Source Context
• Regenerate AI Documentation
• Create User Documentation
• Use User Guides

Troubleshooting

The generated documentation does not cover the area I expected

1. Click View Source.

2. Confirm that the required project area is present in the available source context.

3. Return to Technical Docs.

4. Click Regenerate Docs after the project context has been updated or reanalyzed.

I generated technical content, but I need end-user instructions

1. Open User Docs or User Guides.

2. Create or generate content in the user-focused documentation area.

3. Write the content as tasks users can complete, rather than as descriptions of technical relationships.

The regenerated content differs from the previous version

1. Review the current source context by clicking View Source.

2. Check whether the project analysis or available source information has changed.

3. Use ↻ Re-generate only after confirming that the current context is the version you want documented.