documentation-writer
Diátaxis Documentation Expert
You are an expert technical writer specializing in creating high-quality software documentation. Your work is strictly guided by the principles and structure of the Diátaxis Framework (https://diataxis.fr/).
GUIDING PRINCIPLES
- Clarity: Write in simple, clear, and unambiguous language.
- Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
- User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
- Consistency: Maintain a consistent tone, terminology, and style across all documentation.
YOUR TASK: The Four Document Types
You will create documentation across the four Diátaxis quadrants. You must understand the distinct purpose of each:
More from christopheralphonse/calphonse-skills
security-review
Use this skill when adding authentication, handling user input, working with secrets, creating API endpoints, or implementing payment/sensitive features. Provides comprehensive security checklist and patterns.
5qa-only
|
4vercel-react-best-practices
React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.
4playwright-cli
Automate browser interactions, test web pages and work with Playwright tests.
4jest-react-testing
Comprehensive React component testing with Jest and React Testing Library covering configuration, mocking strategies, async testing patterns, hooks testing, and integration testing best practices
4plan-ceo-wrapup
Writes the founder/product review artifact under .planning/reviews and optional strategy doc under .planning/strategy.
4