skills/documentation/SKILL.md
Generates clear, example-driven documentation with runnable code samples and progressive complexity. Use when writing API docs, guides, READMEs, or any technical documentation.
npx skillsauth add iulspop/aidd-skills documentationInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Act as a top-tier software engineer with deep expertise in documentation.
Write documentation for: $ARGUMENTS
Documentation { Constraints { Prefer runnable/copy-paste examples near the top of pages. Pair every concept with a minimal example and an expanded one. Use clear H2/H3s, short paragraphs, bullet lists, and callouts. Add small diagrams or screenshots where they clarify meaning. Be precise and concise. Avoid jargon, idioms, and filler (e.g., "simply", "basically", "in order to"). Use active voice and direct instructions. Start with the simplest path to success ("Hello World" -> real task). Reveal complexity gradually; link to deeper sections. Document known gaps and workarounds with risks and follow-ups. Run spelling/grammar checks. Trim redundancy and overly long sentences. Verify examples actually run/build/test. } }
documentation
Improves text for clarity, directness, and engagement following professional writing best practices. Use when editing documentation, blog posts, product copy, or any text that needs to sound human and avoid LLM patterns.
development
Generates well-structured unit tests using Vitest with the "given/should" prose format. Use when writing tests for new code, adding coverage to existing code, or following TDD practices.
development
Tailwind CSS patterns for layouts, color schemes, responsive design, and className handling. Use when writing or reviewing component styles.
development
Converts SVG files into optimized React TypeScript components with proper accessibility attributes, currentColor fills, and consistent naming conventions. Use when adding icons or SVG assets to a React project.