Set Up Your Documentation Workspace

page

4 min readUpdated 2026-07-20

Set up your Atloria workspace by creating a project, completing the available setup flow, and opening the project documentation area. This sequence gives you a focused place to organize documentation work before you share the project context with collaborators.

Overview

Atloria organizes documentation work around projects. You start from the Workspace Sidebar or the Projects area, create a project, and then use the project’s setup experience to prepare its documentation workspace.

The setup flow helps you move from a newly created project to the documentation experience. Depending on your needs, you can select Setup to continue preparation, Skip setup to bypass the setup flow, or select View Your Documentation → when the documentation is ready to review.

Use this process whenever you are starting documentation for a new product, repository, service, or team initiative. After the project exists, you can return to the central project list through ← Back to Projects or use Open Project Dashboard to work within the selected project.

📷 Screenshot pending: The workspace project hub showing the Workspace Sidebar, Projects area, search field, and New Project button.

Prerequisites

Before you begin, make sure you have:

Access to the Atloria Workspace.
Permission to create or manage projects in the workspace.
The source or project details you want to document.
A clear project name that your team can recognize in the Projects list.
The names or contact details for collaborators who will review or contribute to the documentation.
An understanding of whether you want to complete the guided Setup flow or use Skip setup.

Step-by-Step Instructions

Open the Workspace Sidebar.
Select Projects to open the list of projects available in your workspace.
Review the project list to confirm that the documentation project does not already exist.
Enter a keyword in Search projects... if you need to locate an existing project before creating a new one.
Select New Project to begin creating a documentation project.
Enter the project details requested on the New Project screen.
Select Create project to add the project to the workspace.
Select the new project from the Projects list to make it the active project.
Confirm that you are working in the correct project by checking the project-focused area rather than the all-projects hub.
Select Setup to start the project setup experience.
Complete each available setup prompt using the project information you prepared before starting.
Select View Your Documentation → when the setup experience indicates that documentation is available.

📷 Screenshot pending: The project setup experience showing Setup, Skip setup, View Your Documentation, and Open Project Dashboard actions.

Select Open Project Dashboard if you need to return to the project’s main working area instead of opening documentation immediately.
Select ← Back to Projects when you need to return to the workspace-wide project list.
Open the project’s documentation area to verify that the new workspace is ready for documentation work.
Use Export Documentation when you need to create an exported copy of the project documentation for review or distribution.
Share the project name and documentation location with your collaborators so they can open the same project in Atloria.
Ask collaborators to confirm that they can find the project from Projects or by using Search across all projects....

Tips and Best Practices

Create one project per documentation scope. Use a distinct project for each product, application, service, or repository you want to document. This keeps documentation, changes, versions, and analytics tied to the correct work.
Use recognizable project names. A clear name makes the project easier to find through Search projects... and Search across all projects..., especially when your workspace contains many projects.
Complete setup before inviting broad review. Use Setup first so the project has a consistent documentation starting point. When the documentation is ready, use View Your Documentation → to review what collaborators will see.
Skip setup only when appropriate. Select Skip setup if the project is already prepared or if you need to reach the dashboard quickly. If you skip the guided flow, verify the documentation area before asking collaborators to begin work.
Keep collaborators aligned on the active project. Atloria provides both a workspace-wide view and a project-focused view. Tell collaborators which project to open, rather than only referring to the overall workspace.
Use exports for formal review. Select Export Documentation when stakeholders need a portable copy. Continue to use the project documentation area as the working source for updates and ongoing review.
Plan review around project changes and versions. After the workspace is established, use the project’s change and version areas to help reviewers understand what has changed over time.

Troubleshooting

You cannot find the project you just created

Select Projects from the Workspace Sidebar.
Enter the project name in Search projects....
Use Search across all projects... if you may be viewing a different project-focused area.
Confirm that you selected Create project after entering the requested project details.

You are in the workspace but not in the correct project

Select ← Back to Projects.
Locate the correct project in the Projects list.
Select the project to make it the active project.
Select Open Project Dashboard to continue working in that project.

You skipped setup and cannot confirm that documentation is ready

Return to the active project.
Select Setup if it is available.
Complete the available setup prompts.
Select View Your Documentation → to verify the documentation area.
Use Export Documentation only after you have reviewed the documentation you intend to share.

Was this page helpful?

Download as PDF

ADocs generated by Atloria — from the code, always in sync →