W Docs

blockmatic/basilic-skills/skills/workflow/w-docs

by blockmatic7e05e2abd052dc6b526e8a28e36d102d42bfd635No license1 starsListed Oct 9, 2026Updated Oct 9, 2026Repository updated 6 days ago

Document the current code or feature in the owning docs layer.

Instructions onlySoftware Development

AI-generated overview

Guides an agent to update the correct documentation layer when code or features change.

What it does: This skill instructs an agent on where and how to document a code or feature change, choosing among technical docs, agent rules, and the nearest README. It describes a five-step process: locate the matching docs section, patch MDX when the canonical explanation changed, patch the README for run/setup/scripts changes, patch a rule only if a constraint changed, and propose a minimal from/to list for mechanical file or doc moves. It also sets constraints such as not committing unless asked and not duplicating MDX content into rules or READMEs.
When to use it: Use it when a code or feature change needs to be reflected in a repository's documentation. It fits repositories that keep technical docs, agent rules, and READMEs as separate layers with defined ownership. It is not meant for creating a new documentation sitemap or for committing changes without being asked.
Requirements: No scripts or special tooling; it is instructions only. It assumes the consuming repository has a docs layer, an AGENTS.md path reference, and README files, and that the agent can edit MDX and Markdown files.

Document the current code or feature. Follow the consuming repo's docs and README rules. Do not commit unless asked. Durable information architecture belongs in existing MDX; do not invent a second sitemap.

Write to the layer that owns the change:

Layer	Role	Update when
Technical docs (path in `AGENTS.md`)	Architecture, ADRs, how-to	Behavior, architecture, commands, conventions, or workflow changed
Agent rules	Short constraints	A convention the agent must not violate changed
Nearest README	How to run this app/package; links only	Scripts, setup, or package purpose changed

Inline comments only when the code is otherwise misleading. Do not copy MDX into rules or READMEs. Do not @-attach MDX.

Identify the matching docs section, then an existing topic page (create a page only if none fits).
Write or patch MDX if the canonical explanation changed.
Patch README only for run/setup/scripts; link the MDX.
Patch the glob-matched rule only if a constraint changed.
For mechanical file or doc moves: propose the smallest from/to list grouped by related files; drop folder-name prefixes inside groups. Save only if the user gave a path. Do not move files unless they also asked to implement.

Source and attribution

Source:blockmatic/basilic-skillsinskills/workflow/w-docsat commit7e05e2a

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

W Docs

Source and attribution

More from blockmatic/basilic-skills

W V0

W Unit

W Ui

W Test

W Tdd

W Shadcn

More in Software Development

Playground

M5 Onboard

Cardputer Buddy

Web Design Guidelines

Vercel React Native Skills

Vercel React Best Practices