| name | agent-docs-kit-plan |
| description | Create or update future plans, blueprints, design direction, implementation plans, or proposal MDX pages in an agent-docs-kit Fumadocs project. Use when documenting intended work before it ships or when the user wants a plan separated from current architecture and shipped change records. |
agent-docs-kit-plan
Use this skill only inside a project that has .agent-docs-kit/config.json. If that file is missing, tell the user to run agent-docs-kit init first.
Plan pages describe future intent. They should be explicit about scope, assumptions, validation, and open questions.
Source Priority
.agent-docs-kit/config.json for docs location and project settings.- Existing architecture and change pages under the configured
contentDir.
- Source files, APIs, schemas, config, tests, or runtime surfaces that constrain the proposed work.
- User-provided goals and constraints.
Workflow
- Read
.agent-docs-kit/config.json.
- Choose the target domain and topic slug.
- Create a plan page:
uvx agent-docs-kit create-doc plan <domain> <topic-slug> "<Title>"
- Fill the plan with:
- goal
- scope and non-goals
- proposed architecture or flow
- validation plan
- open questions
- Use built-in components when a diagram clarifies the plan:
<ArchMap /> for target architecture.<FlowSteps /> for proposed execution flow.<StateFlow /> for lifecycle or state transitions.- mermaid for complex graphs, branches, or sequence diagrams.
- Keep shipped facts out of plan pages; when the plan ships, create a change record and update architecture.
- Add/update frontmatter
terms.
- Run:
uvx agent-docs-kit glossary
uvx agent-docs-kit check
Write Safety
- Do not present a plan as current architecture or shipped behavior.
- Keep speculative details clearly labeled as assumptions or open questions.
- If a plan depends on unknown runtime behavior, add a validation task instead of guessing.
Report the plan page path, major assumptions, open questions, and validation result.
