technical-writer
Write comprehensive technical documentation including user guides, how-to articles, system architecture docs, onboarding materials, and knowledge base articles. Creates clear, structured documentation for technical and non-technical audiences. Use when users need technical writing, documentation, tutorials, or knowledge base content.
Works with
--- name: technical-writer description: Write comprehensive technical documentation including user guides, how-to articles, system architecture docs, onboarding materials, and knowledge base articles. Creates clear, structured documentation for technical and non-technical audiences. Use when users need technical writing, documentation, tutorials, or knowledge base content. license: MIT --- # Technical Writer Create clear, comprehensive technical documentation for any audience. ## Contents - `references/templates.md` — structure templates (user guide, tutorial, architecture) - `references/best-practices.md` — clarity, structure, visuals, code, and quality checklist - `references/special-types.md` — README, release notes, troubleshooting guide requirements - `references/output-format.md` — final delivery wrapper and maintenance notes ## Workflow 1. Identify the documentation type. See `references/special-types.md` for the full type list and type-specific section requirements. 2. Determine the audience: - Technical level (beginner, intermediate, expert) - Role (end user, developer, admin, stakeholder) - Prior knowledge assumptions - Context (internal team, external customers, open source community) 3. Select and fill the matching structure template from `references/templates.md`. Start simple, then layer in complexity. 4. Apply technical writing best practices from `references/best-practices.md`: short sentences, active voice, specific instructions, scannable structure, runnable code examples, and a user-focused angle. 5. Verify the draft against the output quality checklist in `references/best-practices.md`. 6. Deliver using the wrapper in `references/output-format.md`, including the documentation checklist and maintenance notes. ## Example Triggers - "Write user documentation for my feature" - "Create a tutorial for setting up the development environment" - "Document this system architecture" - "Write a troubleshooting guide" - "Create onboarding documentation for new developers" - "Write a README for this project" Generate professional, comprehensive technical documentation that enables users to succeed.
More Project Management skills
firecrawl-build-onboarding
firecrawl/skills
Get Firecrawl credentials and SDK setup into a project. Use when an application needs `FIRECRAWL_API_KEY`, when an agent should add Firecrawl to `.env`, when the user wants to authenticate Firecrawl for app code, or when choosing the first SDK and docs for a new Firecrawl integration. This skill includes its own browser auth flow, so it does not depend on the website onboarding skill.
email-sequence
coreyhaines31/marketingskills
When the user wants to create or optimize an email sequence, drip campaign, automated email flow, or lifecycle email program. Also use when the user mentions "email sequence," "drip campaign," "nurture sequence," "onboarding emails," "welcome sequence," "re-engagement emails," "email automation," "lifecycle emails," "trigger-based emails," "email funnel," "email workflow," "what emails should I send," "welcome series," or "email cadence." Use this for any multi-email automated flow. For cold outreach emails, see cold-email. For in-app onboarding, see onboarding-cro.
onboard
pbakaus/impeccable
Designs and improves onboarding flows, empty states, and first-run experiences to help users reach value quickly. Use when the user mentions onboarding, first-time users, empty states, activation, getting started, or new user flows.
