Skip to content

Skill

Document Generate

gstack

Writes documentation that does not exist yet - reads a feature, module, or whole project and produces the missing docs from scratch. It creates fresh documentation for undocumented code, distinct from updating docs after a release, rendering a doc to PDF, or pulling data off a web page.

Situations it fits

A whole feature shipped with no docs at all. You want documentation created for it from nothing, so new engineers can understand it.
Document Generate. The two documentation skills are the trap. document-generate writes documentation that does not exist yet, from scratch, for undocumented code. By contrast document-release updates EXISTING docs after a change ships, bringing them back in sync with what landed; make-pdf converts a Markdown file into a polished PDF - a format change, not a content change; scrape extracts structured data from a web page that does not hand it over cleanly.
You inherited a module with zero documentation - no README, no API notes, nothing. You want thorough docs written for it from scratch, explaining what it does and how to use it.
Document Generate. The two documentation skills are the trap. document-generate writes documentation that does not exist yet, from scratch, for undocumented code. By contrast document-release updates EXISTING docs after a change ships, bringing them back in sync with what landed; make-pdf converts a Markdown file into a polished PDF - a format change, not a content change; scrape extracts structured data from a web page that does not hand it over cleanly.

3 scenarios in the bank answer to Document Generate. The rest are in the game.

Skills it gets confused with

These share a family with Document Generate, which is another way of saying they are the ones you might reach for by mistake.

Knowing what Document Generate does is the easy half. Telling it apart from the others under time pressure is the game.

Today's session

Document Generate is part of garrytan/gstack. Licence: MIT. The description above was written for this game, not taken from the skill.