agentsclimarketplace
Sign in

Documentation

Skill douglance/sdlc-plugin/.agents/skills/documentation

Use after behavior ships or an interface changes when documentation must be created, corrected, or verified against the source.From its SKILL.md

Install
npx -y skills add douglance/sdlc-plugin --skill documentation

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 5 stars5 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.9 KB, as published. Nobody here has run it

<execution-contract> This skill defines the documentation phase. Use the `technical-writer` agent when bounded documentation work can proceed independently; otherwise work locally. Verify commands, interfaces, and examples against shipped behavior. </execution-contract>

Use lifecycle-documentation only when the result needs a durable artifact or handoff.

<what-to-do>

Document what actually shipped, not what was planned. Read the change, then write the docs a future engineer or agent needs: how to use it, how the interface behaves, and why the key decisions were made.

Docs are only done when they match the shipped behavior. Verify every command, signature, and example against the real code — guesses age into lies.

</what-to-do> <supporting-info>

This skill is ship-time documentation — write the docs once a change lands. For the discipline of capturing decisions as they happen, and the ADR/README formats, see the documentation-and-adrs skill.

What to write

  • README / usage — what it does, how to run it, a working example. Lead with the common path.
  • API / interface docs — the public surface: signatures, parameters, return shapes, errors. Match the code exactly.
  • ADRs — for decisions with lasting consequences: the context, the decision, the alternatives rejected, and the trade-off accepted.

Principles

  • Match the source of truth. Pull examples and signatures from the real code; run commands you document.
  • Why over what. Code shows what; docs explain why and how to use it. Don't narrate the obvious.
  • Concise and current. Smallest doc that conveys it. Stale docs are worse than none.

What to produce

The files written or updated, and a note of anything you found undocumented but out of scope.

</supporting-info>

Keep looking

Skills are one crate of 626,474. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.