Technical Documentation workspaces let you create developer-facing content for a project, including generated technical reference material and imported documentation. Enable this workspace when your project needs documentation for software components, APIs, data structures, configuration, or infrastructure.
Overview
The Technical Docs workspace provides a dedicated area for technical documentation work. Unlike reader-focused documentation, this workspace is intended for content that helps developers understand and work with the technical parts of a project.
You can begin by generating documentation from the project or by bringing in existing material. The workspace supports documentation across categories such as FRONTEND, BACKEND, DATABASE, API SCHEMA, CONFIG, DOCUMENTATION, and INFRASTRUCTURE.
After documentation is available, you can view it, copy content when needed, export it, and optionally use versioning and scheduled documentation updates. These options help you keep developer-facing documentation usable as the project changes.
📷 Screenshot pending: The Technical Docs workspace showing documentation generation and import options.
Prerequisites
Before you start, make sure that you have:
- Access to the project where you want to enable technical documentation.
- Permission to open the project’s Technical Docs area.
- Project information available for documentation generation, if you plan to use Generate Documentation →.
- Existing documentation files or content available, if you plan to use Or import existing documentation.
- A clear decision about whether the documentation should be versioned or updated on a schedule.
Step-by-Step Instructions
-
Open the project that requires developer-facing documentation.
-
Select Technical Docs from the project navigation.
-
Review the Technical Docs workspace to confirm that you are working in the correct project.
-
Select Generate Documentation → to create technical documentation from the available project information.
-
Wait for the workspace to show Generating Documentation while the documentation is being prepared.
-
Review the generated documentation when the workspace displays Documentation Ready!.
-
Select View Your Documentation → to open the generated technical documentation.
-
Use the available documentation style selector to choose the presentation style that best fits your audience.
-
Select Generate after choosing a style if you need to create or refresh the documentation in that style.
-
Select Or import existing documentation instead of generating content if your technical documentation already exists outside Atloria.
-
Complete the import process to add your existing technical documentation to the workspace.
-
Select ⚡ Enable Versioning if you need to preserve and manage documentation versions over time.
-
Enable scheduling when the workspace shows 3. Schedule Enabled and you want documentation updates to occur on a recurring basis.
-
Select Export Documentation when you need a copy of the completed documentation for use outside the workspace.
-
Select Copy beside content that you want to place in another tool, message, or document.
📷 Screenshot pending: The Technical Docs workspace after generation, showing “Documentation Ready!”, “View Your Documentation →”, export, and versioning options.
Tips and Best Practices
-
Generate documentation only after the project information you want documented is available. Technical documentation is most useful when it reflects the current frontend, backend, database, API schema, configuration, and infrastructure details.
-
Use Or import existing documentation when your organization already maintains approved technical content. Importing existing material can help you preserve established terminology, architecture decisions, and team conventions.
-
Review generated content before exporting or sharing it. Generation can organize documentation around technical categories, but you should confirm that the content is appropriate for its intended developer audience.
-
Enable ⚡ Enable Versioning for documentation that changes alongside releases, integrations, or architecture updates. Versioning is especially useful when developers need to distinguish current guidance from earlier documentation.
-
Use scheduling only when regular refreshes are appropriate for your project. A scheduled update can help keep documentation aligned with ongoing changes, but you should still review important updates before distributing them broadly.
-
Choose a documentation style deliberately. A compact style may be helpful for concise reference content, while a more detailed style may be better for onboarding or complex implementation guidance.
-
Export documentation after it reaches a reviewed state. Keep exported copies labeled with the relevant project and version so users can identify the correct material later.
Related Pages
- Generate Documentation
- Import Existing Documentation
- View Technical Documentation
- Enable Documentation Versioning
- Schedule Documentation Updates
- Export Documentation
Troubleshooting
You cannot find the Technical Docs workspace
Confirm that you opened the correct project and that your account has access to its documentation areas. If Technical Docs is not available in the project navigation, contact a project administrator to verify your permissions.
Documentation remains on “Generating Documentation”
Wait for the generation process to complete, then check whether the workspace changes to Documentation Ready!. If the status does not change, refresh the workspace and try Generate Documentation → again after confirming that the project information is available.
You need documentation that differs from the generated result
Use Or import existing documentation to add approved technical content, or select a different documentation style and generate the documentation again. Review the result before using Export Documentation or sharing copied content.
Was this page helpful?