Search

PythonReactSEOPDF
GitHub Skill

documentation-fundamentals

TRIGGERS: "is this documented?", "review my README", "check my docs", "document this", "adding comments", "updating README", "documenting API", "JSDoc", "docstring", "explaining code", "adding description", "API docs", "type annotations", README, JSDoc, docstrings, inline comments, API documentation, code comments. USE WHEN: Junior is BUILDING documentation, adding comments, or explaining code. PROVIDES: WHY-not-WHAT enforcement, README structure, JSDoc standards, comment anti-patterns. PROACTIVE: Triggers when junior mentions documenting or explaining code.

DanielPodolsky☆ 144 Repository stars10 Repository forks

Installation

Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.

View source ↗Guides

Skill instructions

Features and purpose

TRIGGERS: "is this documented?", "review my README", "check my docs", "document this", "adding comments", "updating README", "documenting API", "JSDoc", "docstring", "explaining code", "adding description", "API docs", "type annotations", README, JSDoc, docstrings, inline comments, API documentation, code comments. USE WHEN: Junior is BUILDING documentation, adding comments, or explaining code. PROVIDES: WHY-not-WHAT enforcement, README structure, JSDoc standards, comment anti-patterns. PROACTIVE: Triggers when junior mentions documenting or explaining code.

Quick start

Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.

Guides ↗

Examples

Read the usage examples in the source repository.

View source ↗

Source history

Indexed on
2026-01-23
Index updated
2026-03-05
Branch
main

Index and sync dates describe this directory. View the source repository for code history.

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!