documentation

Write technical documentation, READMEs, and articles following natural prose and punctuation guidelines.

4|Updated Feb 5, 2026
One-click install
npx skills add https://github.com/ki2pixel/After-Effects-Scripts-Plugins-Bundle --skill documentation-ki2pixel
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/ki2pixel/After-Effects-Scripts-Plugins-Bundle/tree/main/.windsurf/skills/documentation
Command: npx skills add https://github.com/ki2pixel/After-Effects-Scripts-Plugins-Bundle --skill documentation-ki2pixel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical writing often sounds robotic, marketing-heavy, or AI-generated, and READMEs frequently duplicate information already visible in the codebase. This Skill provides concrete style rules, structural patterns, and punctuation guidelines so documentation reads naturally and explains design reasoning instead of restating the obvious. ## Core Features & Use Cases - Technical Article Structure: Enforces a proven deep-dive format with TL;DR, problem-first openings, named concepts, ❌/✅ comparison blocks, trade-off tables, and a closing golden rule. - Voice and Tone Control: Distinguishes instructional versus narrative voice, prioritizes user-provided voice samples, and eliminates AI artifacts like excessive bolding, bullet spam, and marketing adjectives. - README and Punctuation Rules: Guides READMEs to explain the "why" behind organization rather than listing files, and replaces the space-hyphen-space AI artifact with semicolons, colons, or em dashes. - Use Case: When drafting a release announcement or architecture article, apply these rules to produce prose with specific numbers, personal voice, and natural flow instead of structured marketing sections. ## Quick Start Use the documentation skill to review and rewrite my README draft so it explains design decisions in natural prose without AI-sounding language.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write a technical article that doesn't sound AI-generated?▼

Start with a personal problem or story, use specific numbers instead of vague claims, and mix short and long sentences in flowing paragraphs. Avoid bold section headers, excessive bullet lists, and marketing words like "revolutionary" or "seamless".

What structure should a technical deep-dive article follow?▼

Open with a TL;DR, then a problem-first scenario, name your key concepts, show ❌/✅ code comparisons, address common misconceptions, include a trade-offs table, and end with one memorable golden rule.

Should a README list the directory structure and files?▼

No. READMEs should explain the reasoning behind organizational choices and architectural principles, not duplicate what users can see with ls. Exhaustive file listings create maintenance burden and go stale quickly.

When should I use narrative versus instructional voice in documentation?▼

Use instructional second-person voice for pattern explanations and best practices. Use first-person narrative only for experience reports and lessons learned where the personal journey adds value. Default to instructional for technical patterns.

How do I fix the space-hyphen-space punctuation pattern in writing?▼

Replace " - " with a semicolon for related independent clauses, a colon when introducing explanations or lists, or an em dash for dramatic pauses. This pattern is a common AI writing artifact.