skills.rest
DanielPodolsky
DanielPodolskyCOMMUNITY
Explore all skills by this author →
𝕏@0shot_devGitHub

documentation-fundamentals

Standardize software documentation with README, JSDoc, and inline comment guidelines.

274|18|Updated Dec 23, 2025
Search Tags:#documentation#onboarding#jsdoc#code-comments#readmes#docs-standards
One-click install
npx skills add https://github.com/DanielPodolsky/ownyourcode --skill documentation-fundamentals
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-fundamentals
Source: https://github.com/DanielPodolsky/ownyourcode/tree/main/.claude/skills/fundamentals/documentation
Command: npx skills add https://github.com/DanielPodolsky/ownyourcode --skill documentation-fundamentals

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about documentation-fundamentals

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

FAQPage Schema
What is WHY-focused documentation and how does it improve code maintainability?▼

WHY-focused documentation explains the rationale behind decisions and usage rather than just describing what code does. It improves maintainability by standardizing READMEs, JSDoc, and inline comments to reveal context.

How do I structure a README for a new software module?▼

Structure a README with What, Why, Installation, Quick Start, and API or Contributing sections. This ensures documentation covers purpose and usage, supporting onboarding and maintainability across software projects.

What should I include in JSDoc blocks and inline comments?▼

JSDoc blocks and inline comments should include rationale and usage explanations rather than mere descriptions. This approach enforces documentation standards that speed up team ramp-up and code reviews.

Does this documentation approach work for onboarding and code reviews?▼

Yes, this documentation approach works for onboarding and code reviews by providing onboarding and review templates. These templates speed up team ramp-up and standardize architectural rationale through ADRs and API guidelines.

What's the best way to standardize documentation across multiple projects?▼

Standardize documentation across projects by applying consistent README structures, JSDoc conventions, and WHY-focused inline comments. This enforces clarity and produces consistent documentation artifacts throughout development.

When do I need Architecture Decision Records for API documentation?▼

You need Architecture Decision Records for API documentation when standardizing architectural rationale across a project. ADRs provide guidelines that capture why decisions were made, improving clarity and maintainability.

Related Skills

Explore More Content & Communication Skills→
masrurimzmasrurimz

doc-writer

Generate JSDoc/TSDoc comments, READMEs, and API documentation across codebases.

Community
Basic
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
nguyenphpnguyenphp
41

lint-and-validate

Run linters, type checkers, and security audits across Node.js and Python projects.

Community
Intermediate
jamestorrevillasjamestorrevillas
3

code-explanation

Generate inline comments and documentation notes explaining code decisions.

Community
Intermediate