Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
Guides documentation standards including READMEs, JSDoc, and code comments.
Install Documentation Fundamentals
$ npx skills add DanielPodolsky/ownyourcode --skill documentation-fundamentals -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install DanielPodolsky/ownyourcode documentation-fundamentals --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/DanielPodolsky/ownyourcode.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/fundamentals/documentation .claude/skills/documentation-fundamentals && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "documentation-fundamentals" agent skill from https://github.com/DanielPodolsky/ownyourcode/tree/main/.claude/skills/fundamentals/documentation into .claude/skills/documentation-fundamentals/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-fundamentals", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/DanielPodolsky/ownyourcode/tree/main/.claude/skills/fundamentals/documentationType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add DanielPodolsky/ownyourcode --skill documentation-fundamentals -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install DanielPodolsky/ownyourcode documentation-fundamentals --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/DanielPodolsky/ownyourcode.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/skills/fundamentals/documentation .agents/skills/documentation-fundamentals && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "documentation-fundamentals" agent skill from https://github.com/DanielPodolsky/ownyourcode/tree/main/.claude/skills/fundamentals/documentation into .agents/skills/documentation-fundamentals/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-fundamentals", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add DanielPodolsky/ownyourcode --skill documentation-fundamentals -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install DanielPodolsky/ownyourcode documentation-fundamentals --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/DanielPodolsky/ownyourcode.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/skills/fundamentals/documentation .cursor/skills/documentation-fundamentals && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "documentation-fundamentals" agent skill from https://github.com/DanielPodolsky/ownyourcode/tree/main/.claude/skills/fundamentals/documentation into .cursor/skills/documentation-fundamentals/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-fundamentals", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/DanielPodolsky/ownyourcode.git --path .claude/skills/fundamentals/documentation--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add DanielPodolsky/ownyourcode --skill documentation-fundamentals -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install DanielPodolsky/ownyourcode documentation-fundamentals --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/DanielPodolsky/ownyourcode.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/skills/fundamentals/documentation .gemini/skills/documentation-fundamentals && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "documentation-fundamentals" agent skill from https://github.com/DanielPodolsky/ownyourcode/tree/main/.claude/skills/fundamentals/documentation into .gemini/skills/documentation-fundamentals/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-fundamentals", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install DanielPodolsky/ownyourcode documentation-fundamentalsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add DanielPodolsky/ownyourcode --skill documentation-fundamentals -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/DanielPodolsky/ownyourcode.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/skills/fundamentals/documentation .github/skills/documentation-fundamentals && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "documentation-fundamentals" agent skill from https://github.com/DanielPodolsky/ownyourcode/tree/main/.claude/skills/fundamentals/documentation into .github/skills/documentation-fundamentals/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-fundamentals", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add DanielPodolsky/ownyourcode --skill documentation-fundamentals -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install DanielPodolsky/ownyourcode documentation-fundamentals --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/DanielPodolsky/ownyourcode.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/skills/fundamentals/documentation .opencode/skills/documentation-fundamentals && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "documentation-fundamentals" agent skill from https://github.com/DanielPodolsky/ownyourcode/tree/main/.claude/skills/fundamentals/documentation into .opencode/skills/documentation-fundamentals/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-fundamentals", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
documentation-fundamentals- GitHub stars
- 290
- Used in
- 1 other repo
- Token cost
- ~1.8k tokens
- SKILL.md length
- 375 words
- Files
- 1
- Skills in repo
- 19
- Repo updated
- First seen
- Licence
- MIT
At a glance
Guides documentation standards including READMEs, JSDoc, and code comments.
- Works in 10 steps: What Is This? (1 sentence) → Why Does It Exist? → How to Install → …
- Writing documentation
- SKILL.md covers When to Apply, The Golden Rule: WHY, Not WHAT, README Structure (The 5… and Comment Types & When to Use Them, plus 9 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Documentation Fundamentals is an agent skill from DanielPodolsky/ownyourcode. Guides documentation standards including READMEs, JSDoc, and code comments. Use when writing documentation, adding comments, or explaining code. Enforces "WHY not WHAT" principle.
Its SKILL.md is about 1.8k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation. The repository describes itself as: Claude Code workflow for AI-mentored development. Work efficiently with Spec-Driven Development and the 6 Gates. Built to fight cognitive offloading — for developers using AI to… The licence is MIT.
When your agent uses it
- Writing documentation
- Adding comments
- Explaining code
Example prompts
- “WHY not WHAT”
- “Use the documentation-fundamentals skill to guide documentation standards including READMEs, JSDoc, and code comments”
- “/documentation-fundamentals”
Requirements
- Node.js
Workflow steps
10 steps, taken from the step headings in SKILL.md.
What it can do on your machine
Read from SKILL.md and the folder at commit bd1f17c. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are typescript and markdown).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Documentation Fundamentals loads about 1.8k tokens when it runs. Until then it costs about 52 tokens; SKILL.md has 375 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from DanielPodolsky/ownyourcode at commit bd1f17c, republished under its MIT licence (© DanielPodolsky). 375 words, ~1,785 tokens.
Download SKILL.mdSave it as
.claude/skills/documentation-fundamentals/SKILL.md (or your agent's skills folder).- name
- documentation-fundamentals
- description
- Guides documentation standards including READMEs, JSDoc, and code comments. Use when writing documentation, adding comments, or explaining code. Enforces "WHY not WHAT" principle.
Documentation Fundamentals Review
"Code tells you HOW, comments tell you WHY. If you only explain what the code does, you're wasting everyone's time."
When to Apply
Activate this skill when:
- Reviewing or creating README files
- Writing JSDoc/docstring comments
- Inline code comments
- API documentation
- Architecture decision records
The Golden Rule: WHY, Not WHAT
// ❌ BAD: Explains what (code already says this)
// Increment counter by 1
counter++;
// ✅ GOOD: Explains why (context the code can't provide)
// Counter must be incremented before validation runs
// to account for the edge case where initial value is 0
counter++;README Structure (The 5 Essentials)
Every README must answer these questions:
1. What Is This? (1 sentence)
"What problem does this solve in one sentence?"
## What
A CLI tool that converts Figma designs to React components.2. Why Does It Exist?
"What pain point motivated this project?"
## Why
Manually converting designs to code takes hours and introduces inconsistencies.
This tool automates the process, ensuring pixel-perfect components.3. How to Install
"Copy-paste instructions that work."
## Installation
npm install your-package4. How to Use
"The simplest possible example that works."
## Quick Start
npx your-tool --input design.fig --output ./components5. How to Contribute (Optional)
"For open source projects."
## Contributing
1. Fork the repo
2. Create your feature branch
3. Submit a pull requestComment Types & When to Use Them
Function/Method Documentation (JSDoc)
/**
* Validates email format and checks domain against blocklist.
*
* @param email - The email address to validate
* @returns ValidationResult with success status and error message
*
* @example
* const result = validateEmail('user@example.com');
* if (!result.success) {
* showError(result.error);
* }
*
* Note: This uses the RFC 5322 regex pattern, which is intentionally
* strict to prevent disposable email addresses.
*/
function validateEmail(email: string): ValidationResult {
// Implementation
}Inline Comments (Only for WHY)
// Rate limit is 100/min but we use 80 to leave headroom for retries
const RATE_LIMIT = 80;
// Sort descending because newest items should appear first
// (business requirement from PM - see ticket #1234)
items.sort((a, b) => b.date - a.date);
// HACK: API returns dates as strings, need to parse manually
// TODO: Remove after backend migration (Q2 2026)
const date = new Date(response.dateString);Block Comments (Complex Logic)
/*
* Authentication Flow:
* 1. Check local token cache
* 2. If expired, attempt silent refresh
* 3. If refresh fails, redirect to login
*
* We use refresh tokens instead of re-authentication to avoid
* disrupting the user experience during long sessions.
*/Common Mistakes (Anti-Patterns)
1. Commenting the Obvious
// ❌ BAD: Useless comment
// Set name to "John"
const name = "John";
// Get the user's age
const age = user.age;
// Loop through items
for (const item of items) { ... }
// ✅ GOOD: No comment needed (code is self-explanatory)
const name = "John";2. Outdated Comments
// ❌ BAD: Comment doesn't match code (dangerous!)
// Filter out inactive users
const users = data.filter(u => u.role === 'admin');
// ✅ GOOD: Comment matches reality
// Only show admin users in management view
const users = data.filter(u => u.role === 'admin');3. No Context on Magic Numbers
// ❌ BAD: What is 86400?
const expiresIn = 86400;
// ✅ GOOD: Explains the magic
const SECONDS_PER_DAY = 86400;
const expiresIn = SECONDS_PER_DAY; // Tokens expire after 24 hours4. Commented-Out Code
// ❌ BAD: Dead code polluting the file
// const oldImplementation = () => { ... };
// function deprecatedHelper() { ... }
// ✅ GOOD: Delete it! Git remembers everything5. Empty README
<!-- ❌ BAD: Auto-generated, never updated -->
# my-project
This project was bootstrapped with Create React App.Socratic Questions
Ask these instead of giving answers:
- WHY not WHAT: "Does this comment tell me something the code doesn't?"
- Audience: "Would a developer joining tomorrow understand this?"
- Maintenance: "If you change the code, would you remember to update this comment?"
- README: "Can someone run this project with just the README instructions?"
- JSDoc: "What would a developer need to know to use this function correctly?"
- Necessity: "If you delete this comment, is anything lost?"
Show full SKILL.md (140 more words)Show less
README Template
# Project Name
One-sentence description of what this does.
## Why
The problem this solves and why it matters.
## Installation
npm install project-name
## Quick Start
Minimal code example that works.
## API
### functionName(param)
Description of what it does.
**Parameters:**
- `param` (string): What this parameter is for
**Returns:** What gets returned
**Example:**
```js
// Usage exampleConfiguration
Available options and their defaults.
Contributing
How to contribute (if applicable).
License
MIT (or your license)
---
## JSDoc Essentials
```typescript
/**
* Brief description of what this function does.
*
* @param paramName - Description of parameter
* @returns Description of return value
* @throws {ErrorType} When this error occurs
* @example
* // Show how to use it
* const result = myFunction('input');
*
* @see RelatedFunction for similar functionality
* @deprecated Use newFunction instead (v2.0+)
*/Red Flags to Call Out
| Flag | Question |
|---|---|
| Empty README | "Can a new developer run this project right now?" |
// Set x to 5 | "Does this comment add value? The code already says this." |
| Outdated comments | "Does this comment still match what the code does?" |
| No JSDoc on exports | "How would someone know how to use this function?" |
| Commented-out code | "Why is this here? Git has history if you need it back." |
| Magic numbers | "What does 3600 mean? Why this number?" |
Interview Connection
"I maintain comprehensive documentation including READMEs, JSDoc comments, and architecture decision records, ensuring code is maintainable by the entire team."
Documentation habits demonstrate:
- Communication skills
- Long-term thinking
- Team player mentality
- Senior-level maturity
MCP Usage
Context7 - Framework Docs
Fetch: JSDoc documentation
Fetch: Markdown best practicesOctocode - Real Examples
Search: README.md patterns in popular repos
Search: JSDoc examples in TypeScript projects© DanielPodolsky, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .claude/skills/fundamentals/documentation of DanielPodolsky/ownyourcode.
Open the folder on GitHubat commit bd1f17c
Used in 1 other repository
We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in DanielPodolsky/ownyourcode, which our catalogue first saw on October 7, 2026.
Compare with similar skills
Documentation Fundamentals next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Documentation Fundamentals this skillDanielPodolsky/ownyourcode | 290 | 1 repos | ~1.8k | Automated safety check: Pass | MIT | |
| Diagram Designcathrynlavery/diagram-design | 47k | 1 repos | ~7.5k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Doc SyncJetBrains/ideavim | 10k | 2 repos | ~2.6k | Automated safety check: Pass | MIT | |
| Mailspring App ScreenshotsFoundry376/Mailspring | 18k | — | ~1.5k | Automated safety check: Pass | GPL-3.0 | |
| Draw.io Diagram StudioAgents365-ai/drawio-skill | 10k | — | ~2.4k | Automated safety check: Notes | MIT |
Similar skills
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
- Official
Doc Sync
JetBrains/ideavim
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
Dark Architecture Diagram Builder
Cocoon-AI/architecture-diagram-generator
Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.
More from DanielPodolsky/ownyourcode
All 19 skills in this repoAccessibility Fundamentals
DanielPodolsky/ownyourcode
Reviews accessibility including WCAG, ARIA, keyboard navigation.
Backend Fundamentals
DanielPodolsky/ownyourcode
Reviews API design, REST conventions, and backend architecture.
Database Fundamentals
DanielPodolsky/ownyourcode
Reviews schema design, SQL queries, ORM patterns. An agent skill from DanielPodolsky/ownyourcode.
Error Handling Fundamentals
DanielPodolsky/ownyourcode
Guides error handling for async operations and API calls. An agent skill from DanielPodolsky/ownyourcode.
Frontend Fundamentals
DanielPodolsky/ownyourcode
Reviews React/Vue component architecture, state, and hooks. An agent skill from DanielPodolsky/ownyourcode.
Performance Fundamentals
DanielPodolsky/ownyourcode
Reviews performance including N+1 queries, re-renders, scalability.
Related
Categories
Questions about Documentation Fundamentals
What does Documentation Fundamentals do?
Guides documentation standards including READMEs, JSDoc, and code comments. Documentation Fundamentals is an agent skill from DanielPodolsky/ownyourcode. Guides documentation standards including READMEs, JSDoc, and code comments.
When should I use Documentation Fundamentals?
Documentation Fundamentals fits situations like: writing documentation; adding comments; explaining code.
How do I install Documentation Fundamentals in Claude Code?
Run `npx skills add DanielPodolsky/ownyourcode --skill documentation-fundamentals -a claude-code`. Or copy the skill folder (.claude/skills/fundamentals/documentation in DanielPodolsky/ownyourcode) into .claude/skills/documentation-fundamentals in your project. Claude Code loads it when a task matches its description.
How do I install Documentation Fundamentals in Codex?
Run `npx skills add DanielPodolsky/ownyourcode --skill documentation-fundamentals -a codex`. Or copy the skill folder (.claude/skills/fundamentals/documentation in DanielPodolsky/ownyourcode) into .agents/skills/documentation-fundamentals in your project. Codex loads it when a task matches its description.
Can I use Documentation Fundamentals in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add DanielPodolsky/ownyourcode --skill documentation-fundamentals -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-fundamentals, .gemini/skills/documentation-fundamentals, .github/skills/documentation-fundamentals and .opencode/skills/documentation-fundamentals in your project.
What does Documentation Fundamentals need to run?
SKILL.md names no scripts, command-line tools or credentials: Documentation Fundamentals is instructions for the agent only. Our summary lists: Node.js.
Does Documentation Fundamentals access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Documentation Fundamentals safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Documentation Fundamentals use?
Documentation Fundamentals is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Documentation Fundamentals use?
About 1.8k tokens (SKILL.md is roughly 7.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Documentation Fundamentals?
Skills that share tags, products or a category with Documentation Fundamentals: Diagram Design (cathrynlavery/diagram-design, 47k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Documentation Fundamentals?
DanielPodolsky (a GitHub user) maintains it in DanielPodolsky/ownyourcode, which has 290 GitHub stars. The repository holds 19 skills in this directory. The repository was last updated on June 27, 2026.
Source: DanielPodolsky/ownyourcode on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.