Skills
.Work. You
Rest

documentation-fundamentals

Community

Documentation standards that reveal WHY.

Content & Communication#documentation#onboarding#jsdoc#code-comments#readmes#docs-standards
AuthorDanielPodolsky
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill provides a clear, consistent approach to documenting software projects, focusing on why decisions were made and how to use components, rather than just describing what the code does.

Core Features & Use Cases

  • Readme structure guidance to ensure sections cover What, Why, Installation, Quick Start, and API or Contributing.
  • JSDoc/docstring and inline-comment conventions that emphasize rationale and usage.
  • Onboarding and review templates that speed up team ramp-up and code reviews.
  • ADRs (Architecture Decisions) and API documentation guidelines to standardize architectural rationale.
  • Use Case: A developer adds documentation to a new module, including a README, JSDoc blocks, and WHY-focused inline comments to support maintainability.

Quick Start

Generate a documentation package by creating a README with What, Why, Installation, Quick Start, and API sections; include JSDoc blocks for public functions and inline comments that explain rationale.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: documentation-fundamentals
Download link: https://github.com/DanielPodolsky/ownyourcode/archive/main.zip#documentation-fundamentals

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.