agentleFS
Sign inStart free
buildomatorbuildomator/buildomator/skills/docs-update/SKILL.md

docs-update

Skill102 starsChanged 8 days agoMITView on GitHub

Generate or update project documentation verified against the codebase

17 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 16 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If a documented flag is absent from $ARGUMENTS, treat it as inactive

    line 21
  2. Very specific:

    If --force and --verify-only both appear in $ARGUMENTS, --force takes precedence </objective>

    line 24
  3. Distinctive:

    If neither token appears, run the standard full-phase generation flow

    line 41
  4. Distinctive:

    Do not infer that a flag is active just because it is documented in this prompt </context>

    line 42

“Common” is measured: kept by at least 6 in 10 of the 16 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md
<objective> Generate and update up to 9 documentation files for the current project. Each doc type is written by a bm-doc-writer subagent that explores the codebase directly — no hallucinated paths, phantom endpoints, or stale signatures.

Flag handling rule:

  • The optional flags documented below are available behaviors, not implied active behaviors
  • A flag is active only when its literal token appears in $ARGUMENTS
  • If a documented flag is absent from $ARGUMENTS, treat it as inactive
  • --force: skip preservation prompts, regenerate all docs regardless of existing content or GSD markers
  • --verify-only: check existing docs for accuracy against codebase, no generation (full verification requires Phase 4 verifier)
  • If --force and --verify-only both appear in $ARGUMENTS, --force takes precedence</objective>

<execution_context> @${CLAUDE_PLUGIN_ROOT}/workflows/docs-update.md </execution_context>

<context> Arguments: $ARGUMENTS

Available optional flags (documentation only — not automatically active):

  • --force — Regenerate all docs. Overwrites hand-written and GSD docs alike. No preservation prompts.
  • --verify-only — Check existing docs for accuracy against the codebase. No files are written. Reports VERIFY marker count. Full codebase fact-checking requires the bm-doc-verifier agent (Phase 4).

Active flags must be derived from $ARGUMENTS:

  • --force is active only if the literal --force token is present in $ARGUMENTS
  • --verify-only is active only if the literal --verify-only token is present in $ARGUMENTS
  • If neither token appears, run the standard full-phase generation flow
  • Do not infer that a flag is active just because it is documented in this prompt</context>
<process> Execute the docs-update workflow from @${CLAUDE_PLUGIN_ROOT}/workflows/docs-update.md end-to-end. Preserve all workflow gates (preservation_check, flag handling, wave execution, monorepo dispatch, commit, reporting). </process>

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free