new-guide
SolidCreate or substantially revise user guides, pack pages, and journey pages using Diátaxis plus conversation-first UX. Use when asked to write, simplify, restructure, audit, or modernize tutorials, how-to guides, reference pages, explanations, pack pages, or journey pages so readers can start from a natural-language goal, see what to say, understand what happens next, and reach an outcome without learning internal skill names first. Do NOT use for feature contracts (use `new-spec`), cross-cutting proposals (use `new-rfc`), recording decisions (use `new-adr`), minor single-line edits (normal PR), contributor docs, docstrings, release notes, or blog posts.
Install
Quality Score: 80/100
Skill Content
Details
- Author
- eugenelim
- Repository
- eugenelim/agent-ready-repo
- Created
- 2 months ago
- Last Updated
- today
- Language
- Python
- License
- Apache-2.0
Bundled in these plugins
Similar Skills
Semantically similar based on skill content — not just same category
writing-docs
Use when writing, restructuring, or reviewing any prose documentation — a tutorial, how-to guide, reference page, or explanation/conceptual doc — for a public docs site (e.g. Mintlify MDX, docs/, README material), a getting-started guide, an API/CLI reference page, or a "why we built it this way" conceptual page. Applies the Diátaxis framework (see https://diataxis.fr/) — every document belongs to exactly one of the four quadrants (tutorial / how-to guide / reference / explanation), and mixing quadrants inside one document is the single most common documentation failure. Covers the four-quadrant compass for picking the right form, per-quadrant structure templates, an anti-pattern list for quadrant drift, and generic voice/craft rules — repo-specific voice and target output format (e.g. Mintlify MDX) are resolved from the repo's docs-manifest (falling back to project-context), never hardcoded here.
research-to-guide
Transform already validated research into a clear, evidence-faithful user guide without losing claims, limitations, sources, application, or prototypes. Owns reader contract, composition, narrative style, examples, prototype, and coverage audit. Use to rewrite, convert, expand, structure, or turn a research report, technical analysis, market study, domain review, literature review, findings file, or baseline document into a guide, playbook, handbook, tutorial, decision guide, or separate user-facing MD. Responsibility boundary: does not conduct the primary research and does not choose PDF typography/layout; use `researcher` before it and `guide-pdf` after it. Triggers: 'turn this research into a guide', 'make a user-friendly MD', 'переработай исследование в гайд', 'добавь применение и прототип', 'не потеряй важное'.
project-guides
Create verified project documentation from the real repository: a self-contained visual GUIDE.html for operators, a cited DEVELOPER-INDEX.md for maintainers, and optionally AI-CONTEXT.md. Use when Codex is asked to document a project, create a user guide, build a developer index or technical reference, generate the two companion guides, or prepare durable context for a future coding session.