youlianvr

document

Write or update repository/product documentation: README, user guides, API docs, architecture, migration notes, and changelog material. This is not the Word-document artifact skill.

youlianvr 1 1 Updated 2d ago
GitHub

Install

npx skillscat add youlianvr/oper-share/document

Install via the SkillsCat registry.

SKILL.md

Document

When to use

Use for repo/product docs: README, guides, API docs, architecture, migrations, changelog notes.

Non-goals

  • Not Word/DOCX authoring (use docx).
  • Not release publication (use release only when explicit).

Workflow

  1. Identify the doc audience and location.
  2. Prefer updating existing docs over creating duplicates.
  3. Keep commands and paths verified.
  4. Call out unknowns instead of inventing them.

Categories