Quickstart

This guide walks you through creating a workspace, connecting a GitHub repository, and generating your first developer document. By the end, you'll have one document generated from your code and a document project that's ready to receive proposed updates as the code changes.

Prerequisites#

• A GitHub repository with the code you want to document, either personal or owned by an organization
• For an organization repository, the ability to get approval from a GitHub organization admin
• Editor or higher permissions in the workspace so you can create document projects (whoever creates a workspace first is its owner)
• A Pro, Max, Team, or Enterprise plan. Document projects are a paid plan feature. The Pro and Team plans can start with a 14-day free trial.

Create your first document#

1. Sign up and create a workspace

   Sign up at specify.app and create a workspace. You can start on the free plan without a credit card. To use document projects, switch to the Pro plan or higher (see Plans).

2. Open Create project

   Select the New (+) button in the sidebar, then choose Create project. The Document project setup tab opens in the center.

   

3. Connect GitHub

   In the Source step, select Connect GitHub, then grant Specify access to the GitHub account and repositories it should read.

   

   Organization repositories connect after a GitHub organization admin approves the request. Once it's approved, select reconnect on the same screen to finish. For details, see Connect GitHub.

4. Choose a source

   Pick a GitHub account, choose the Repository and Branch to document, then select Next. This repository and branch become the evidence for every document and proposed update that follows.

5. Choose document types

   In the Documents step, select the document skills the agent should create first. If there's something to emphasize this time, describe the audience, the topics to emphasize, and the level of detail you want in Focus for this run (optional). For example, you could write "Center it on the deployment procedure."

6. Choose an update mode

   In the same step, turn on Automatically update on repository changes to have Specify prepare proposed document updates whenever code lands on the selected branch. Skills that regenerate the whole document every time don't support automatic updates; regenerate those when you need to.

7. Confirm your first document is generated

   Select Create N document types, and the document agent writes the selected documents. You can close this screen. The Inbox keeps tracking the generation task and shows completed, failed, and try-again options.

After generation finishes#

Generated pages keep links to their sources, so you can review later repository changes against precise evidence. Continue with the next steps.

Troubleshooting#