SpecDown

Key Concepts

Understanding the core building blocks of SpecDown helps you get the most out of the platform.

Projects

A Project is the top-level container for your documentation. Think of it as a repository — it holds all your documents, manages access control, and tracks Git sync settings.

Each project has a unique slug (e.g. my-api-docs) used in share links and the CLI. You can have multiple projects across different teams or products.

Free plan: 1 project. Pro: up to 5 projects. Team: unlimited.

Documents & Folders

Document

A Markdown file with a title, content, and a unique path within the project.

Folder

A container that groups related documents. Folders can be nested to any depth.

Every document and folder has a full_path like guides/api/authentication. This path is used by Git sync, the CLI, and share links.

Roles & Permissions

SpecDown uses Role-Based Access Control (RBAC) at the project level. Each member of a project is assigned one of five roles:

RoleReadEditManage MembersDelete Project
Owner
Admin
Editor
Viewer
Publicvia link

Roles are enforced at the database level via Row-Level Security — even direct API access respects these permissions.

Every document can be shared via a token-based share link. Visitors don't need a SpecDown account to read shared documents.

TypePlanDescription
PublicFreeAnyone with the link can read
Password-protectedProVisitors must enter a password
ExpiringProLink automatically expires after a set date

Version History

Every time you save a document, SpecDown automatically creates a version snapshot — but only if the content has changed (detected by SHA-256 hash). This prevents bloating your version history with identical saves.

Version history is available on Pro andTeam plans.

Plan Overview

Free

1 project, 10 docs, public share links

Pro

Unlimited docs, Git sync, MCP, version history

Team

Everything in Pro + team members, comments, admin

Ready to get started?

Write specs like code. Sync with Git. Share with your team.