skills/describe-docs-system/SKILL.md
Documentation system location and maintenance requirements. Load when consulting or updating project documentation.
npx skillsauth add adamrdrew/ushabti describe-docs-systemInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Project documentation lives in .ushabti/docs/.
.ushabti/docs/
├── index.md # Index of all project documentation
└── *.md # Documentation on project systems
Scribe: MUST consult .ushabti/docs/ when planning Phases. Understanding documented systems is prerequisite to coherent planning.
Builder: MUST consult .ushabti/docs/ during implementation. When code changes affect documented systems, update the relevant docs. Include docs files in the touched list in progress.yaml when updated.
Overseer: MUST verify that docs are reconciled with code changes before declaring a Phase complete. Stale docs are defects.
A Phase cannot be marked complete until docs are reconciled with the code work performed during that Phase. This is a hard requirement enforced by Overseer.
data-ai
Set the status field in a phase's progress.yaml. Use instead of manual Edit calls when transitioning phase status.
development
Query the status of a phase. Returns structured status information for external consumers.
data-ai
Mark a step as implemented in progress.yaml with notes and touched files. Use after completing each step instead of manual Edit calls.
testing
# List Cards Scan and list all Hieroglyphs-compatible cards in `.ushabti/cards/`, with optional filtering by status or other criteria. ## When to Use Use this skill when: - You need to see all available work items - Looking for cards in a specific state (e.g., only `todo` cards) - Determining which cards to plan next - Checking card priorities and types ## Card Location Cards are stored in: ``` .ushabti/cards/{slug}/card.md ``` Each card is a directory containing a `card.md` file with YAML