writing-web-documentation

Write and review developer-facing documentation for web software projects.

Updated Aug 16, 2026
One-click install
npx skills add https://github.com/Aveer/skills --skill writing-web-documentation-aveer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-web-documentation
Source: https://github.com/Aveer/skills/tree/main/skills/writing-web-documentation
Command: npx skills add https://github.com/Aveer/skills --skill writing-web-documentation-aveer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve? Technical documentation for web projects often mixes page types, buries prerequisites, and ships stale or unrunnable examples, leaving readers confused and maintainers overwhelmed. This Skill provides a structured workflow for planning, writing, and reviewing developer docs that are scannable, accurate, and maintainable. ## Core Features & Use Cases - Page-type discipline: Separates README/landing pages, quickstarts, tutorials, how-to guides, reference pages, explanations, troubleshooting, and migration guides so each page serves one reader intent. - Ready-made templates and checklists: Ships Markdown skeletons for every page type plus a documentation brief, information architecture template, and a final review checklist. - House style and web-project rules: Enforces active voice, task-based headings, runnable code examples, version and prerequisite hygiene, accessibility, and docs-as-code maintenance habits. - Use Case: When asked to write a quickstart for a new SDK, the Skill inventories facts (install commands, runtime versions, environment variables), builds a skeleton, writes one happy path with a visible success state, and runs the review checklist before delivery. ## Quick Start Ask the assistant to write or review a documentation page for your web project, specifying the page type such as quickstart, tutorial, reference, or migration guide.

Frequently Asked Questions about writing-web-documentation

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

FAQPage Schema
How do I write a good quickstart guide for a web project?▼

A quickstart should show one happy path to a working result with minimal branching. State prerequisites, runtime versions, and package manager up front, use copy-pasteable commands, and end with a visible success state plus next steps.

What is the difference between a tutorial and a how-to guide?▼

A tutorial teaches by doing, guiding a beginner through building something meaningful with checkpoints and a recap. A how-to guide solves one concrete problem for a reader who already knows the basics, focusing on outcome rather than theory.

How should I structure API reference documentation?▼

Reference pages should include a summary, syntax, a parameters table with types and defaults, return values, behavior notes, an errors table, compatibility requirements, and minimal runnable examples. Optimize for lookup and scanning, not narrative flow.

When should I not use this documentation skill?▼

Do not use it for marketing copy, legal text, or non-technical customer-support articles. It is designed specifically for developer-facing technical documentation for web software projects.

How do I keep technical documentation from going stale?▼

Inventory facts that change often, such as versions, commands, and environment variables, before writing. Update docs in the same change as the code, show version context on pages, and run a review checklist that flags stale assumptions.