doc-architect

Scan the repository to generate a documentation sitemap in .agent/workspace/doc_sitemap.json.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/Swear4/agent_rules --skill doc-architect-swear4
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-architect
Source: https://github.com/Swear4/agent_rules/tree/main/agent-universal/skills/doc-architect
Command: npx skills add https://github.com/Swear4/agent_rules --skill doc-architect-swear4

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scans the codebase (using the .geminiignore) to produce an exhaustive user documentation sitemap in .agent/workspace/doc_sitemap.json and to plan articles across all required types.

Core Features & Use Cases

  • Generates a complete sitemap with seven article types: reference, guide, concept, troubleshooting, tutorial, quickstart, and playbook.
  • Enforces Phase 2 of the Documentation KB pipeline (doc-ignorer → doc-architect → doc-writer → doc-translator) and supports optional business-use-cases.md for Playbooks.
  • Validates structure, ensures non-overlapping article topics, and guarantees per-section coverage with i18n-friendly slugs and related_files validation.

Quick Start

Run the doc-architect phase after doc-ignorer to generate the sitemap.

Frequently Asked Questions about doc-architect

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a documentation sitemap from my codebase?

Generating a documentation sitemap from your codebase involves scanning the repository using .geminiignore to produce an exhaustive doc sitemap in .agent/workspace/doc_sitemap.json, covering seven article types including reference, guide, and concept.

What article types do I need for a complete user documentation sitemap?

A complete user documentation sitemap requires seven article types: reference, guide, concept, troubleshooting, tutorial, quickstart, and playbook, with playbooks gated by the presence of a business-use-cases.md file.

How do I map codebase files to a documentation plan?

Mapping codebase files to a documentation plan requires scanning the repository and ensuring related_files exist in the codebase for every planned article, validating structure and guaranteeing per-section coverage with i18n-friendly slugs.

Do I need a business-use-cases.md file to generate playbooks?

Yes, you need a business-use-cases.md file to generate playbooks. Playbooks are gated by the presence of this file, while the other six article types like quickstart and tutorial generate regardless.

When should I run the doc-architect phase in the documentation pipeline?

You should run the doc-architect phase after the doc-ignorer phase to generate the sitemap. This enforces the Phase 2 pipeline sequence: doc-ignorer, doc-architect, doc-writer, then doc-translator.

What is the minimum article threshold for a valid documentation sitemap?

A valid documentation sitemap must reach the minimum article threshold enforced during generation. The sitemap validates structure, ensures non-overlapping article topics, and guarantees per-section coverage across all seven article types.