Skip to content

v1.35.0.0 feat: add /document-generate skill + enhance /document-release with Diataxis coverage map#1477

Open
garrytan wants to merge 7 commits into
mainfrom
feat/document-release-diataxis
Open

v1.35.0.0 feat: add /document-generate skill + enhance /document-release with Diataxis coverage map#1477
garrytan wants to merge 7 commits into
mainfrom
feat/document-release-diataxis

Conversation

@garrytan
Copy link
Copy Markdown
Owner

@garrytan garrytan commented May 13, 2026

Moved from #1427 (garrytan-agents fork) so eval CI can access base-repo secrets.

What

Inspired by @doodlestein's documentation-website skill and the FrankenTUI docs site it produced. Two changes:

  1. New /document-generate skill — writes missing documentation from scratch using the Diataxis framework
  2. Enhanced /document-release — now audits documentation coverage gaps and suggests /document-generate as follow-up

These two skills compose like Unix pipes: /document-release finds what's missing, /document-generate fills the gaps.


New: /document-generate

Writes high-quality documentation from scratch for a feature, module, or entire project. Uses the Diataxis framework (tutorial / how-to / reference / explanation).

9-step workflow:
0. Scope and Intent — confirm target, output format, where docs go

  1. Codebase Archaeology — deep research phase, reads code + tests + comments before writing anything
  2. Diataxis Partitioning — decide which quadrants each entity needs (decision matrix included)
  3. Write Reference — factual, complete, code-derived (foundation layer, written first)
  4. Write Explanation — design rationale, trade-offs, "why" docs with ASCII diagrams
  5. Write How-Tos — task-oriented guides with prerequisites, steps, verification, troubleshooting
  6. Write Tutorials — learning-oriented, hard rule: working result within 3 steps
  7. Cross-Document Linking — ensure discoverability from README within 2 clicks
  8. Quality Self-Review — accuracy, completeness, and voice gates
  9. Commit and Output — structured summary with quadrant breakdown

Key design principles stolen from @doodlestein:

  • Research-first, write-second (the "Partition" phase maps everything before drafting)
  • Reference docs written first (establish vocabulary for other quadrants)
  • Composable with other skills (can be called standalone or from /document-release)
  • Ambitious scope as a feature ("boil the lake" — write complete docs, not minimal)

Enhanced: /document-release

Step 1.5: Coverage Map (Blast-Radius Analysis)

New step between Pre-flight and Per-File Audit. Scans the diff for new public surface and assesses documentation coverage across Diataxis quadrants. Flags gaps but never auto-generates — suggests /document-generate when significant gaps are found.

Architecture Diagram Drift Detection

Parses entity names from ASCII/Mermaid diagrams, cross-references against the diff. Flags stale diagrams.

Enhanced CHANGELOG Sell Test

0-3 Diataxis rubric: +1 for "what changed" (reference), +1 for "why care" (explanation), +1 for "how to use it" (how-to). Entries scoring less than 2 get rewritten.

Documentation Debt in PR Body

Step 9 now appends a ### Documentation Debt section with critical gaps, common gaps, and stale diagrams.


Files Changed

  • document-generate/SKILL.md.tmplNEW template for /document-generate
  • document-generate/SKILL.md — generated output
  • document-release/SKILL.md.tmpl — enhanced template
  • document-release/SKILL.md — regenerated output

View in Codesmith
Need help on this PR? Tag @codesmith with what you need.

  • Let Codesmith autofix CI failures and bot reviews

Documentation

  • README.md — added /document-generate row to skills table (Technical Writer category); updated install-command skill lists in both Claude Code and Codex/AGENTS sections
  • SKILL.md.tmpl + SKILL.md — added routing line: "User asks to write docs from scratch, generate documentation, document this feature/module → invoke /document-generate"
  • CLAUDE.md — added document-generate/ to project structure tree; added new "Checking out PRs from garrytan-agents" section documenting the fork-PR secret-access workflow
  • gstack/llms.txt — auto-regenerated to include /document-generate entry
  • VERSION — 1.34.0.0 → 1.35.0.0 (MINOR: new skill + substantial enhancement)

Documentation Debt

The following are flagged for follow-up (not blocking this PR):

  • Tutorial coverage for /document-generate — no getting-started walkthrough in README beyond the skills-table row. Diataxis quadrant: tutorial. Would help first-time users learn-by-doing rather than reading the skill template cold. Consider: a short "First doc generation in 90 seconds" section in README.
  • Explanation coverage for Diataxis adoption — no ARCHITECTURE.md entry on why gstack uses Diataxis as its doc-quadrant lens (Procida origin, why this vs. just-write-markdown). Diataxis quadrant: explanation. Low priority; explanation is in the skill prose itself.
  • CHANGELOG entry — this branch has no CHANGELOG entry yet. Will be added by /ship when the PR is ready to land (one entry under ## [1.35.0.0] covering both the new skill and the doc-release enhancements).

docs-debt label recommended on this PR.

Hermes Agent and others added 6 commits May 11, 2026 12:07
…ction, and docs debt tracking

Inspired by @doodlestein's documentation-website skill. Three key ideas incorporated:

1. Step 1.5: Coverage Map (Blast-Radius Analysis) — before editing any docs,
   scan the diff for new public surface and assess documentation coverage across
   Diataxis quadrants (reference/how-to/tutorial/explanation). Flags gaps without
   auto-generating content.

2. Architecture diagram drift detection — extracts entity names from ASCII/Mermaid
   diagrams and cross-references against the diff to catch stale diagrams.

3. Enhanced CHANGELOG sell test — Diataxis rubric scoring (0-3) replaces the
   subjective 'would a user want this?' check.

4. Documentation Debt section in PR body — surfaces coverage gaps and diagram
   drift as actionable items for future work.

All changes are audit-only: the skill flags what's missing, never auto-generates
missing documentation pages. Stays in its lane as a post-ship updater.

Co-Authored-By: Hermes Agent <agent@nousresearch.com>
New /document-generate skill, the companion to /document-release. While
/document-release audits and fixes existing docs post-ship, /document-generate
writes missing documentation from scratch using the Diataxis framework.

Inspired by doodlestein documentation-website-for-software-project skill.

Co-Authored-By: Hermes Agent <agent@nousresearch.com>
CI's check-freshness step ran gen:skill-docs and found llms.txt stale —
the index wasn't regenerated when /document-generate was added in the
preceding commit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Main brought in the Non-ASCII characters directive in the AskUserQuestion
Format resolver (scripts/resolvers/preamble/generate-ask-user-format.ts).
Regenerating document-generate/SKILL.md propagates the new section into
the generated output. check-freshness should now pass.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Fork PRs from non-collaborators don't get base-repo secrets passed to
their CI workflows, so eval/E2E jobs fail with empty-env auth. New
section: when checking out a PR from garrytan-agents, push the branch
to garrytan/gstack and re-target the PR from there.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

E2E Evals: ✅ PASS

3/3 tests passed | $.33 total cost | 12 parallel runners

Suite Result Status Cost
e2e-workflow 1/1 $0.29
llm-judge 1/1 $0.02
llm-judge 1/1 $0.02

12x ubicloud-standard-2 (Docker: pre-baked toolchain + deps) | wall clock ≈ slowest suite

- README.md: add /document-generate to skills table (Technical Writer
  category) + install-command skill lists
- CLAUDE.md: add document-generate/ to project structure tree
- SKILL.md.tmpl + regenerated SKILL.md: add /document-generate routing
  line ("write docs from scratch")
- VERSION: 1.34.0.0 → 1.35.0.0 (MINOR: new skill + enhancement)

CHANGELOG entry deferred to /ship.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@garrytan garrytan changed the title feat: add /document-generate skill + enhance /document-release with Diataxis coverage map v1.35.0.0 feat: add /document-generate skill + enhance /document-release with Diataxis coverage map May 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant