doc

Featured

Use for ANY operation on a doc under docs/ — creating, updating/editing, changing its status, or querying. Keeps the YAML front matter (title/status/type/updated) correct and regenerates the docs/README.md wiki index. Invoke when the user says 'new doc', 'create a doc/design/RFC', 'start a design doc', 'update the doc', 'edit this doc', 'mark this doc done/in-review', 'change the doc status', or asks 'which docs are done/draft', 'what am I still working on', 'list my docs by status', '新建文档', '建一个设计文档/RFC', '更新文档', '改一下这个文档', '把这个文档标记成完成/评审中', '哪些文档写完了', '我还有哪些没做完的文档', '按状态列出文档'.

AI & Automation 436 stars 36 forks Updated today MIT

Install

View on GitHub

Quality Score: 89/100

Stars 20%
88
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Project docs — create & query Every doc under `docs/` carries its status in **YAML front matter** at the very top of the file. That front matter is the **single source of truth** — there is **no** central index/JSON to keep in sync. "What's done?" is answered by scanning the front matter live (see *Query*). This skill writes that front matter when creating a doc, and reads it when querying. `docs/README.md` is the human-facing **wiki** for the folder: it explains the organization and holds a generated index table between `<!-- BEGIN docs-index -->` / `<!-- END docs-index -->` markers. That table is a **derived view**, not a source of truth — regenerate it from front matter (see *Maintain the wiki index*); never hand-edit the rows. ## Front matter schema ```yaml --- title: <free text — the human title> status: draft # see vocabulary below type: design # design | rfc | marketing created: 2026-06-28 # YYYY-MM-DD, only the day the doc was first written updated: 2026-06-28 # YYYY-MM-DD, bump on every meaningful edit related: # optional — sibling filenames (YYYYMMDD- prefix under design/) - 20260719-vibe-island-status.md --- ``` - `status` vocabulary (a doc moves down this list over its life): - `draft` — being written, nothing committed to. - `in-review` — content complete, awaiting sign-off. - `approved` — signed off, not yet built. - `active` — currently being executed / lived against (e.g. a strategy memo). - `done` — fully delive...

Details

Author
termio-sh
Repository
termio-sh/termio
Created
3 months ago
Last Updated
today
Language
Swift
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category