Document collections help you group related documentation and present it in a predictable hierarchy. Use collections when your project contains related documents that should be discovered, reviewed, and maintained together.
Overview
In Atloria, documents are managed from the Documents area. You can use the available configuration workflow to define how related documentation is organized, including the order in which document groups appear and the hierarchy pattern they follow.
A useful hierarchy reflects the way your teams consume documentation. For example, you may group material by delivery stage, such as FRONTEND, BACKEND, DATABASE, API SCHEMA, CONFIG, DOCUMENTATION, and INFRASTRUCTURE. This makes it easier for readers to move from an implementation area to the related supporting material.
Collection planning is especially important before you generate or import a large number of documents. A consistent structure improves search results, reduces duplicate content, and helps readers understand where a document belongs.
📷 Screenshot pending: The Documents area and the available configuration entry point for organizing document collections.
Prerequisites
Before you configure document collections, make sure that:
- You can access the Documents area.
- You have selected the correct project, if Atloria displays Select a project to view documents.
- You know which documents should belong together.
- You have agreed on the hierarchy that your organization wants readers to follow.
- You have identified whether content will be created in Atloria or brought in through Or import existing documentation.
- You have the required administrative permissions to change documentation configuration.
Step-by-Step Instructions
-
Open Documents from the application navigation.
-
Select the project you want to configure if the page displays Select a project to view documents.
-
Review the existing documents by using the Search documents... field.
-
Search for related content by entering a document name, category, or project in Search documents, categories, projects....
-
Click Configure → to open the available documentation configuration options.
-
Define a collection for documents that share the same purpose, audience, or delivery area.
-
Assign a hierarchy pattern that places related collection levels in the intended reading order.
-
Use a lifecycle-oriented sequence when your documents follow implementation stages, such as FRONTEND → BACKEND → DATABASE → API SCHEMA → CONFIG → DOCUMENTATION → INFRASTRUCTURE.
-
Place documents that describe configuration work in the CONFIG portion of the hierarchy.
-
Place documentation intended for end users or internal readers in the DOCUMENTATION portion of the hierarchy.
-
Add new content by clicking Create New Document when a required document does not yet exist.
-
Click Create Document to begin creating the new document.
-
Use Or import existing documentation when the document already exists outside Atloria.
-
Return to the document list by selecting ← Back to Documents after completing your configuration changes.
-
Verify the resulting organization by searching for documents with Search documents....
📷 Screenshot pending: The configuration screen showing collection definitions and the hierarchy pattern used to organize related documents.
Tips and Best Practices
-
Use one hierarchy pattern consistently. If your organization uses delivery stages, keep the same sequence across collections. For example, do not place database guidance before frontend guidance in one collection and reverse the order in another unless there is a clear reader-focused reason.
-
Group by reader need, not only by technical ownership. A collection should help a reader find connected information. A backend-owned document may still belong alongside frontend material if both are needed to complete the same task.
-
Use categories to improve discovery. The document search experience supports searching across documents, categories, and projects. Consistent category naming makes collection content easier to find.
-
Create collections before generating large amounts of content. Select Generate Documentation → only after you understand where generated documents should appear in the overall structure.
-
Separate configuration guidance from implementation guidance. When using a staged hierarchy, keep setup and environment instructions under CONFIG, while end-user or reference material belongs under DOCUMENTATION.
-
Review imported documents after import. Imported content may use naming or organizational conventions that differ from your current collection hierarchy. Confirm that it appears in the intended collection before sharing it broadly.
-
Use document comparison when reviewing structural changes. If a collection reorganization involves revising documents, use the document comparison view to confirm that content changes are intentional before communicating the updated structure.
Related Pages
- Manage Documents
- Create a New Document
- Import Existing Documentation
- Generate Documentation
- Compare Document Changes
- Export Documentation
- Configure CI/CD
Troubleshooting
You cannot see documents for the project
If the page displays Select a project to view documents, select the appropriate project before searching or configuring collections. Documents are shown in the context of the selected project.
Search does not return the documents you expect
Try both available search experiences. Use Search documents... for document-focused searching, and use Search documents, categories, projects... when you need to search across document names, categories, and projects. Also check whether the document is in a different project.
A document does not fit the current hierarchy
Review the document’s purpose and its primary reader. Move it to the collection stage that best represents what the reader needs to do next. If the document spans several stages, keep it in the primary stage and add clear links to related documents in adjacent stages.
You need to remove obsolete collection content
Review the documents first, then use Delete Documents only for content that is no longer needed. Export documentation before deleting content when you need to preserve a record of the previous collection structure.
Was this page helpful?