askill
doc-architect

doc-architectSafety 95Repository

Generate Triple-Layer AGENTS.md documentation by scanning a project for its tech stack, data directory, and planning directory. Use when the user asks to standardize project documentation, generate agent files, or create AGENTS.md guides.

3 stars
1.2k downloads
Updated 3/4/2026

Package Files

Loading files...
SKILL.md

Doc Architect

Design and generate a portable Triple-Layer AGENTS.md documentation set that reflects the project’s real structure and constraints.

Modularize Instructions (Token Economy): Avoid consolidating all AI/dev guidance into a single CLAUDE.md. Prefer smaller, focused docs (e.g., docs/setup.md, docs/api.md, docs/workflows.md) and reference them only when needed.

Documentation Standards (MANDATORY): ALL generated markdown files must follow strict formatting rules:

  • 500-line hard limit - no exceptions for any .md file
  • Two-tier structure: High-level TOC (Tier 1) + Deep dive docs (Tier 2)
  • Smart subdirectory grouping for related documentation
  • See skills/doc-standards.md for complete requirements

Core Outcome

Produce three aligned AGENTS.md files:

  • Root AGENTS.md: Project identity, tech stack, global standards
  • Data AGENTS.md: Data integrity rules and schema governance
  • Planning AGENTS.md: Spec-driven development workflow

Trigger Phrases

The skill should activate when the user asks to:

  • Standardize project documentation
  • Generate agent files

Standard Operating Procedure (SOP)

  1. Scan the workspace

    • Inspect the root for identifiers (README, PROJECT_BRIEF, TECH_STACK, ARCHITECTURE, CLAUDE, package.json, composer.json, *.sln, pyproject.toml).
    • Locate likely data directories (database/, schema/, migrations/, sql/, db/).
    • Locate planning/documentation directories (docs/, docs/plans/, planning/, specs/).
    • Identify module/area entry points (menus, docs, feature folders) to group specs.
    • Note template conventions (public/ as web root, per-panel includes, API outside public).
  2. Identify the environment

    • Determine primary language (PHP/C#/Python or other).
    • Determine DB type (MySQL/PostgreSQL/SQLite/SQL Server/other).
    • Determine deployment environment (Docker/Kubernetes/shared hosting/cloud).
  3. Set up plan grouping (first-time)

    • Create docs/plans/<module>/ subdirectories for each discovered module/area.
    • Update docs/plans/AGENTS.md with the current module list.
    • Create or update docs/plans/INDEX.md as the master plan status index.
    • Ensure the index includes status, urgency, last implementation date, and last modification date.
    • Keep docs/plans/AGENTS.md updated whenever plans are added or their status changes.
    • Maintain a folder map at the top of docs/plans/AGENTS.md and update it when requested.
    • Note that developers can add new folders and update the list manually.
  4. Generate Triple-Layer docs

Bundled Resources

Common Pitfalls

  • Do not invent tech stacks. Only infer from files found in the workspace.
  • Do not place AGENTS.md in arbitrary locations; follow the best-fit paths above.
  • Do not include contradictory rules across the three layers.

Quick Example

If a project uses Laravel + MySQL with docs/plans and database/schema:

  • Root: AGENTS.md → PHP/Laravel, MySQL, deployment standards
  • Data: database/schema/AGENTS.md → referential integrity, no-delete rules
  • Plans: docs/plans/AGENTS.md → spec.md format and workflow steps

Install

Download ZIP
Requires askill CLI v1.0+

AI Quality Score

87/100Analyzed 2/19/2026

Well-structured documentation generation skill with clear SOP, trigger phrases, and reusable templates. Covers tech stack scanning, triple-layer AGENTS.md generation, and includes bundled resources. Not internal-only; appears designed as a general-purpose skill. Minor gap: no icon metadata but otherwise comprehensive.

95
90
85
85
90

Metadata

Licenseunknown
Version-
Updated3/4/2026
Publisherpeterbamuhigire

Tags

apidatabasegithub-actionsllm