docup
Review and update bounded repository documentation by category (testing, architecture)
Docup
Use this skill only when the user explicitly invokes /docup <category> or
otherwise names a supported Docup category.
Supported categories: testing, arch.
Interpret the explicit category as plain request text. Accept exactly one supported category. If the category is missing, unknown, or ambiguous, report the supported categories and stop without editing files. Do not depend on harness-specific argument substitution or nested slash-command behavior.
After selecting a category, read only its companion guide from the installed
skill's references/ directory:
testing→references/DocupTesting.mdarch→references/DocupArch.md
Apply the selected guide's bounded workflow to the current repository. Keep one repository and one category in scope, inspect at most 10 evidence files, and make at most 3 documentation edits in one invocation. Preserve accurate text and report a no-op when no evidenced update is needed. Do not change code, create tickets, run global apply/init operations, or launch another skill as a side effect.
Report the evidence inspected, concrete drift found, files changed, and checks actually run. State any remaining uncertainty when the scope cap prevents a complete review.
- Content
- resource-backed
- License:
- AGPL-3.0-or-later
- Origin
- first-party
- Source:
- docs/commands/Docup.md
- Source revision
4e3b8d592416fbf93a2af218882c1abef78faed6- Requires
- Targets
- codex, claude
- Invocation
- /docup
Resource: references/DocupArch.md
Docup Architecture
Maintain the target repository's architecture and design documentation. Treat the target project as the source of truth; do not assume its language, framework, runtime, deployment model, interface, or document layout.
Inspect these sources first, stopping at the Docup evidence cap:
AGENTS.mdand applicable local instructions.- The repository's documentation index, README, and existing architecture or design documents.
- Top-level manifests, build files, entry points, and deployment descriptors.
- The smallest relevant set of implementation files and tests that establish the selected architecture claims.
- At most 10 relevant recent commits when history is needed to confirm drift.
Discover the project's shape before choosing the review surface. Depending on the repository, that may include a library API, CLI, desktop or TUI app, web application, web service, worker, system service, data pipeline, plugin, or a combination. Identify the real boundaries between components, users or callers, storage, external services, processes, and deployment environments.
Review one architecture surface per invocation. The user may name a focus in plain request text; otherwise choose the smallest clearly bounded surface from the target project's own documentation and structure. Check that the selected documentation agrees with the implementation about boundaries, responsibilities, data or control flow, lifecycle, configuration, failure behavior, and runtime assumptions. Check referenced paths, commands, links, and diagrams as part of the same review.
Update the existing architecture or design document when possible. If the project has no suitable document, create the smallest conventional document indicated by its own documentation layout and link it from the relevant index. Preserve the project's terminology and format. Do not introduce a generic architecture taxonomy merely to fit this workflow.
Keep the work bounded:
- inspect at most 10 evidence files;
- edit at most 3 documentation files;
- change no code, configuration, issues, generated files, or installations;
- report a no-op when the selected surface is accurate;
- report remaining uncertainty when the project shape or evidence cap prevents a reliable conclusion.
Report the project shape inferred, architecture surface reviewed, evidence inspected, concrete drift found, files changed, and checks actually run.
Resource: references/DocupTesting.md
Docup Testing
Maintain the repository's testing guide at docs/Testing.md.
Inspect these sources first, stopping at the Docup evidence cap:
AGENTS.mdand the repository's applicable local instructions.docs/Testing.mdanddocs/other/Canary.md.Makefiletargets for checks, tests, lint, smoke, install, and canaries.- Representative
*_test.gofiles andscripts/smoke-test.shor relevantscripts/canary-*entry points. - At most 10 relevant recent commits when history is needed to confirm drift.
Compare the guide with the repository's actual verification layers: package tests, integration-style tests, static checks, smoke tests, canaries/live checks, and manual or visual verification. Check commands, paths, and links against their definitions. Look for concrete omissions or stale instructions; do not turn this into a general repository audit.
If the evidence shows drift, make only the smallest documentation edits needed
to docs/Testing.md and related documentation links. Make no more than 3
documentation edits in one invocation. If the guide is accurate, make no edits
and report a no-op.
Verify changed links and formatting, and run the narrowest relevant checks. Do not run live canaries merely to review documentation unless the documentation claims depend on a mechanism that cannot be checked from its definition. Report checks run separately from checks only inspected.
Related skills
- domain-modeling — Build and sharpen a project's domain model. Use when discussing codebase terminology, writing or editing a CONTEXT.md, or recording or editing an ADR.
- evergreen — Create/update evergreen docs and issue files for the current session
- grill-with-docs — A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
- grilling — Grill the user relentlessly about a plan, decision, or idea. Use when the user wants to stress-test their thinking, or uses any 'grill' trigger phrases.