authoring-brainpalace-docs

Solid

Use when `brainpalace sync-docs --fix` reports PROSE-NEEDED, when a new command/skill/mode needs its human prose (Purpose, Examples) written, or when a human wants to mark a doc-verifier UNVERIFIABLE claim as human-confirmed. Authoring playbook for interface docs whose machine regions are generated.

AI & Automation 2 stars 0 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 81/100

Stars 20%
16
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Authoring BrainPalace interface docs The deterministic generator owns the **machine regions** (frontmatter `parameters:`, `GENERATED:*` blocks). You write the **human prose** only — never edit inside a `GENERATED:` block. ## Flow 1. Run `brainpalace sync-docs --fix`. It regenerates machine regions and prints `PROSE-NEEDED: <id> -> <doc> (<reason>)` for anything that needs prose. 2. For each PROSE-NEEDED item, open the doc and write, **outside** any GENERATED block: - `## Purpose` — one short paragraph from `brainpalace <cmd> --help` (what it does, not why). Use only flags/behavior that actually exist. - `### Examples` — 1–3 real invocations. 3. Write prose **only where it is missing or dangling** — do not reword existing valid prose (keeps commits churn-free). 4. Re-run `brainpalace sync-docs --check` until it prints `doc-sync: OK`. ## Rules - Never invent flags/commands/modes — verify against `--help` / `sync-docs --check`. - Never edit inside `<!--GENERATED:…-->` blocks (the generator overwrites them). - English only; match the surrounding docs' tone. ## Confirming an UNVERIFIABLE claim as human-verified The doc-verifier fails closed: there is **no manual "mark confirmed" backdoor**. A prose claim becomes human-confirmed only by reaching the **`audit` source tier** — recorded `verdict: SUPPORTED, grounding_tier: audit` in `scripts/doc_verify_cache.json`. The audit tier engages only when **both** hold: 1. The claim is **`unresolved` tier** — its grou...

Details

Author
bxw91
Repository
bxw91/brainpalace
Created
1 months ago
Last Updated
3 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

generate-docs

Generate or update incremental developer documentation in the target project's own docs site: diff-driven how-to guides for what a unit of work changed, written through a discovered docs adapter (Starlight/Astro MDX is the first-class reference; plain markdown is the always-available fallback). Never a whole-project pass; never scaffolds a website; never edits source code. On Claude Code and want hand-tuned per-skill model/effort tiers? Install the `#claude` branch instead (`npx skills add gtrabanco/agentic-workflow#claude`) — see the README. This branch is model-agnostic: the skill inherits whatever model and effort your agent session is already using. Triggers: "generate the docs", "update the docs site", "document this unit", "document what changed", "generate-docs".

19 Updated 1 weeks ago
gtrabanco
AI & Automation Solid

humanize-docs

Transform AI-generated documentation into human-readable prose with personality. USE WHEN: Converting rigid AI docs (checklist spam, CAPS LOCK emphasis, perfect symmetric structures, template dumps) into flowing, conversational writing that feels colleague-authored. Different from /humanizer — that skill detects AI writing patterns (Wikipedia taxonomy). This skill does aggressive deformalization of document structure and flow. PRIMARY TRIGGERS: "humanize this doc", "make this readable", "remove AI patterns from doc", "add human touch to this" See also: humanizer skill for text-level AI pattern removal.

11 Updated today
wrg32786
AI & Automation Solid

doc-standards

Documentation writing-quality standards — controlled language (ASD-STE100), Google/Microsoft style guide rules, ISO 24495 plain language, AI/agent readability (llms.txt, self-contained sections), and a machine-checkable lint gate. Use whenever writing or reviewing ANY documentation prose — README, API reference, tutorial, how-to, changelog, error message, code comment blocks, llms.txt — even if the user only says "write docs", "document this", "improve the README", "docs smell like AI", or "make the docs clearer". Structure/coverage questions (which doc types exist) belong to a Diátaxis-structure skill if one is installed; THIS skill governs how each sentence and section is written, and provides the lint gate to verify it.

8 Updated 4 days ago
JuanMarchetto