docs-plan

Generates a tiered documentation plan with page inventory, coverage table, and delete list from repository evidence.

Updated Aug 13, 2026
One-click install
npx skills add https://github.com/ocx-sh/grimoire-lore --skill docs-plan-ocx-sh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-plan
Source: https://github.com/ocx-sh/grimoire-lore/tree/main/skills/docs-plan
Command: npx skills add https://github.com/ocx-sh/grimoire-lore --skill docs-plan-ocx-sh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Teams struggle to decide what documentation a project actually needs, often writing pages that mirror existing content or guessing at user priorities. This Skill turns a repository's own evidence—CLI surface, issues, changelogs, and real friction-log runs—into one durable, auditable discovery artifact. ## Core Features & Use Cases - Evidence-based discovery: Enumerates every subcommand, entry point, issue title, and changelog entry as candidate tasks, forbidding candidates sourced from existing docs page titles. - Friction logs and user needs: Runs real first-time-persona task attempts with verbatim output, then writes one "As a X, I need to Y, so that Z" need per task with solution-shape rejection. - Typed inventory and IA plan: Types every existing page against a nine-value doc_type enum, maps needs to pages, assigns three tiers (first-steps, everyday, integration), and produces a coverage table, delete list, and nav plan. - Use Case: A maintainer of a CLI tool asks which docs pages to write, merge, or delete before a release; the Skill produces a docs/discovery/use-cases.yaml artifact ranking tasks by a named signal and flagging stub pages for deletion. ## Quick Start Ask the assistant to run a docs discovery on this repository and produce a tiered documentation plan with a page inventory and coverage table.

Frequently Asked Questions about docs-plan

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I plan what documentation a project needs?▼

Run a discovery procedure that enumerates the tool's subcommands, entry points, issues, and changelog entries as candidate tasks, then ranks them by a named signal like friction-log severity. The output is one artifact with user needs, a page inventory, a coverage table, and an IA plan.

How do I audit existing documentation for gaps and pages to delete?▼

Inventory every published page with a prose word count and a doc_type, map each task to a page or mark it missing, and build a coverage table. A page goes on the delete list only when no user need maps to it and it is a stub under 150 prose words or an exact duplicate.

What is a friction log in documentation discovery?▼

A friction log records a named first-time persona attempting a real task, with three sections: Context, Pros and cons, and a stream of consciousness containing verbatim terminal output. It must never include a proposed-fix section, and logs without real output are disqualified.

Does this skill write the documentation pages themselves?▼

No. It produces the discovery artifact, coverage table, delete list, and seeded doc_type declarations only. Writing prose is handled separately by the docs-quality rules, and the delete list is never applied without maintainer approval.

When should a page be typed as a tutorial versus a how-to?▼

A tutorial is required only when the reader must assemble two or more interacting concepts before the tool is useful, following one non-branching path. Otherwise the page is a quickstart or how-to, and typing it as a tutorial imports obligations it does not need.