Skip to content

Commit 47363ad

Browse files
ankur-archclaude
andcommitted
docs(skill): record the house guide style for hands-on pages
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent b436d39 commit 47363ad

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

.claude/skills/docs-writer/SKILL.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@ The same rule applies inside sections: when a paragraph packs several decisions
138138
139139
Never lean on internal vocabulary ("runtime family", "lowering", "execution stack") without a one-line plain definition at first use.
140140
141+
For hands-on guides (anything that builds something), follow the house guide style used by /docs/guides/runtimes/bun and the middleware authoring guide: an Introduction stating what the reader builds, Prerequisites, short numbered step headings ("## 1. Create the middleware"), one action per step with the exact file path on every code block, the real expected output after the step that produces it, a likely-failure line where a step commonly breaks, and options or reference material only after the working result.
142+
141143
## Cut the slop
142144
143145
Delete these on sight. They add length, not clarity.

0 commit comments

Comments
 (0)