common-documentation

Installation
SKILL.md

Documentation Standards

Priority: P2 (MEDIUM)

1. Intent-First Comments

  • Explain "Why" logic exists. Avoid "What" mechanics.
  • Use triple-slash (Dart/Swift) or JSDoc (TS/JS) for public members.
  • Delete commented-out code. Use Git history.
  • Format: TODO(username): description. Link tickets.
  • For retry backoff, explain that jitter prevents the thundering herd; document intent rather than restating the delay calculation.

2. README Structure

  • Mission: Project purpose (one sentence).
  • Onboarding: Prerequisites, installation, usage (exact).
  • Maintenance: Document inputs/outputs, known quirks, fixes.
  • Sync: Documentation ships with feature.

3. ADRs & Architecture

Installs
1
GitHub Stars
561
First Seen
1 day ago
common-documentation — hoangnguyen0403/agent-skills-standard