writing-documentation
Writing documentation
When to apply
- Creating or updating Markdown documentation in the project
- Creating or updating AI-facing content: skills (
SKILL.md), rules, similar instructional docs
New documentation: template first
Before drafting new documentation, do not proceed with a full write-up until one of the following is satisfied:
- User provides a template — follow it for structure and sections.
- No template given — propose 1–2 concrete outline options (or a minimal default template: title, overview, sections matching the doc type) and confirm or adjust with the user before writing the body.
Updates to existing docs do not require this step unless the user is effectively starting a new doc from scratch.
Core principles
More from cedmandocdoc/awesome-skills
building-react-native-application
Guides building Expo/React Native apps with TypeScript using a consistent architecture and library stack (NativeWind, React Navigation, TanStack Query, Zustand, Axios). Use for all React Native application work.
24building-react-application
Guides building React web applications with TypeScript using consistent patterns for effects, data fetching, component structure, shared JS utilities, and date handling. Use when implementing or reviewing React UI, hooks, side effects, or utility usage in browser-based apps.
21building-react-web-application
Guides building Vite + React SPA apps with TypeScript using a consistent architecture and library stack (Tailwind CSS v4, class-variance-authority, TanStack Router file-based routes, TanStack Query, Zustand, Axios, shadcn-style tokens, primitives in src/ui). Use when creating a new React web project or updating architecture/UI/state/API/routing/styling to follow these conventions.
17reviewing-documentation
Reviews Markdown and AI-facing documentation for clarity, structure, style, and formatting against project writing standards. Use when reviewing docs, doc PRs, SKILL.md or rules, or when the user asks whether documentation is well written or needs improvement.
4react-native
Opinionated React Native ecosystem for building apps with a consistent architecture, library stack, and UI patterns
1