Alan Docs

Documents and artifacts

Where each kind of written output lives in Alan, and how to choose between a document and an artifact.

Alan keeps written work in two places:

  • A document is standalone knowledge that belongs to the team, such as a PRD, spec, or wiki page.
  • An artifact is an output of a specific piece of work: a task, an automation, or a session.

Choose by purpose: use a document for knowledge the team will reuse, even when you write it during a task. Use an artifact for that task's plan, report, or other deliverable.

At a glance

DocumentArtifact
Belongs toA team, or the whole organization in Workspace DocsExactly one task, automation, or standalone session
TypesDocument, whiteboardPlan, Test report, Document, Whiteboard
Find it inDocs in the team sidebarThe task or session's Artifacts panel
Typical contentPRDs, specs, meeting notes, roadmaps, architecture sketchesA plan to approve, test evidence, a task summary, a diagram for one change
Created byYou or an agent, often from a templateUsually an agent while it works; you can also choose New in Artifacts
Comments✅✅
Public linkShare → Publish to webPublish from the artifact viewer
OrganizeFolders and nested pagesGrouped by its task, automation, or session

Artifact types

TypeCaptures
PlanWhat will change, why, how it will be verified, and open decisions
Test reportWhat was tested, with screenshots and recordings, and a pass, fail, or mixed result
DocumentA written deliverable from the work, such as a summary, spec, or notes
WhiteboardA diagram or sketch on a canvas

Read pull request reviews under Alan Review on the pull request. When you start a review for a pull request with a primary linked task, Alan also creates a document artifact on that task. See Task artifacts.

Team docs and Workspace Docs

  • Team docs live under Docs in a team (/teams/{teamId}/docs). Everyone in the team can open them.
  • Workspace Docs are organization-wide documents and whiteboards (/workspace/wiki). They appear in the sidebar when Workspace Docs is turned on in Settings → Organisation → General, and need the Enterprise tier.

See Documents, Whiteboard, and Organisation settings.

Sharing outside Alan

Documents, whiteboards, and artifacts can all be published to a public, read-only link that anyone with the link can open. Check for secrets and customer data before publishing, and unpublish to turn the link off. See Links and IDs.

Next steps

On this page