write-guide

Writes verified long-form developer guides as Markdown files assembled from a section library.

Updated Jun 8, 2026
One-click install
npx skills add https://github.com/shawn-sandy/agentics-kit --skill write-guide-shawn-sandy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-guide
Source: https://github.com/shawn-sandy/agentics-kit/tree/main/kit/plugins/social-media-tools/skills/write-guide
Command: npx skills add https://github.com/shawn-sandy/agentics-kit --skill write-guide-shawn-sandy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing in-depth developer documentation is slow and error-prone: guides often ship unverified URLs, stale file paths, and paraphrased sources that mislead readers. This Skill produces long-form developer guides on any project topic with a mandatory verification spine, so every cited URL, path, and quoted fact is checked against its source before publication. ## Core Features & Use Cases - Section-library assembly: Builds each guide from twelve documented section intents in references/skeleton.md, choosing, ordering, and blending sections to fit the topic rather than forcing a fixed template. - Five starting archetypes: Offers system-explainer, rule-deep-dive, how-to, concept-explainer, and change-recap shapes as non-binding starting points, selected via a picker table in references/exemplars.md. - Mandatory verification discipline: Requires WebFetch confirmation of every external URL and Read/Grep confirmation of every on-disk path, symbol, and frontmatter field before citing it, with verbatim quoting of primary sources. - Use Case: Ask for a deep-dive on a project convention like a review-bot loop rule, and receive a saved docs/plans/guides/review-bot-loop-discipline.md with verbatim frontmatter quotes, an ASCII flow diagram, a quick-reference card, and cross-references. ## Quick Start Ask the assistant to write a guide on a specific project topic, for example: write a developer guide explaining how the memory recall system works and save it to the docs folder.

Frequently Asked Questions about write-guide

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

FAQPage Schema
How do I write a developer guide for a project topic?▼

Invoke the skill with a request like "write a guide on X" or "deep-dive X". It gathers facts from the conversation, files, git history, and code search, assembles a guide from a twelve-section library, and saves it as a verb-target kebab-case Markdown file in a guides directory.

What guide formats and archetypes does this skill support?▼

It supports five non-binding archetypes: system-explainer, rule-deep-dive, how-to tutorial, concept-explainer, and change-recap. Each is a starting shape drawn from the section library, and sections can be added, dropped, reordered, or blended to fit the topic.

Where are the generated guides saved?▼

Guides are saved to a guides subfolder inside the configured plansDirectory if one exists, otherwise to docs/guides/ if present, or docs/ at the repo root as a fallback. An explicit user-specified path overrides all resolution rules.

When should I not use this guide-writing skill?▼

Do not use it for README updates, API reference docs, marketing copy, blog posts, status reports, commit messages, or plan-completion documentation. Those belong to direct edits, other skills like share-blog or internal-comms, or inline notes.

How does the skill verify facts before publishing a guide?▼

Every external URL is confirmed with WebFetch before citation, and every file path, function name, line number, and frontmatter field is confirmed with Read or Grep. Primary sources are quoted verbatim, and unverifiable facts are explicitly marked as unverified.