read-docs-exemplars
General↓ 0 installsUpdated 170d ago
Curatedgardusig
>-
SKILL.md preview
---
name: read-docs-exemplars
description: >-
Read-only: markdown-first public documentation exemplars (links + patterns) and a filtering rubric before
adopting external ideas. Callers: write-quality-documentation, @git-docs. Does not write files or copy
third-party bodies.
---
# Internal: Public documentation exemplars (`read-docs-exemplars`)
**Read-only library.** **Pointers and rules only** — use when **`write-quality-documentation`** or **`@git-docs`** should borrow **structure** (headings, tables, troubleshooting blocks) from well-known **markdown-in-repo** documentation. **Do not** paste large chunks of external text without license checks; **do not** bypass **`write-quality-documentation`** / **`@git-docs`** for substantive doc edits.
## Language interaction policy
Always apply [`read-safety-language-interaction-rules`](../../safety/language-interaction-rules/SKILL.md) first. Use English by default for all assistant output, including AskQuestion prompts/options, unless the user explicitly requests another full-language response.
## Skill ownership (sanctioned doc changes)
External repos inform **patterns** only; changes still flow through **`@git-docs`** or **`@git-review`** §8a → **`write-quality-documentation`**.
```mermaid
flowchart TB
classDef neuM fill:#eceff1,color:#111
classDef pub2 fill:#1976d2,color:#fff
classDef int2 fill:#00897b,color:#fff
classDef int3 fill:#4db6ac,color:#111
subgraph ext [External]
EX[Markdown_exemplars]
end
subgraph skills [Sanctioned_writers]
GD[git-docs]
IDOC[write-quality-documentation]
REV[gh-review_8a]
end
EX -.->|"patterns_only"| GD
EX -.->|"patterns_only"| IDOC
REV --> IDOC
class EX neuM
class GD pub2
class IDOC int2
class REV int3
```
---
## Curated shortlist (markdown in tree)
Primary artifact should be **`.md` in the repository** (not a static site generator as the only source of truth).
| Source | Why it is useful | Extract | Skip |
| --- | --- | --- | --- |
| [github/opensource.guide](https://github.com/github/opensource.guide) | Short chapters; strong **contributing / community / legal** tone | Heading depth, “when to use this page”, cross-links, checklist-style sections | Product-specific GitHub UI copy |
| [thegooddocsproject](https://github.com/thegooddocsproject) (repos under the org) | Explicit **doc-type** templates (how-to, tutorial, reference stubs) | Skeleton ideas: prerequisites, steps, “see also”, troubleshooting | Toolchain-specific assumptions; verbatim merges without license review |
| Large OSS **`docs/`** trees in markdown (e.g. **eslint**, **nodejs** `doc/`, **pandas** narrative docs) | Real **guide vs reference** separation | How they split narrative from catalogs; tables and version notes | Install matrices and commands that are not this repo’s truth |
| **Small libraries** with clear READMEs (e.g. **semver**-style) | Above-the-fold clarity | First-screen structure; minimal badge/link discipline | Marketing READMEs that do not fit a skill-pack repo |
**Out of scope for this skill (do not treat as copy sources here):** Diátaxis site prose; Docusaurus / VitePress / MkDocs **site source** as template (SSG coupling). You may still map ideas mentally (tutorial vs how-to vs reference) without copying those sites.
---
## Filtering rubric (before adopting a pattern)
Apply when changing **`docs/README.md`**, **`docs/<domain>/.../README.md`**, **minimal root** **[`README.md`](../../../../README.md)**, or (legacy) monolithic **`docs/*`** files:
1. **Portability** — Works as **static markdown** with relative links and optional mermaid (**[`write-quality-documentation`](../../internal/write/quality/documentation/SKILL.md)** prefers mermaid).
2. **Hub fit** — Maps to **one** surface: **Quick guide / install** (root README), **skill catalog** (**`docs/git.md`** / **`docs/gh.md`** / **`docs/read.md`** / **`docs/write.md`** or a slimmer layout on other repos), **diagram** (mermaid in **`docs/README.md`** or d
…