documentation

Name: documentation
Availability: InStock
Author: wellcrafted-dev

Generate folder READMEs, JSDoc comments, and code comments.

35|4|Updated Dec 18, 2024

Search Tags:#documentation #project structure #developer experience #readme #code comments #jsdoc

Ready to run

npx skills add https://github.com/wellcrafted-dev/wellcrafted --skill documentation-wellcrafted-dev

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/wellcrafted-dev/wellcrafted/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/wellcrafted-dev/wellcrafted --skill documentation-wellcrafted-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you write clear, concise, and informative documentation for your code, folders, and project structure, ensuring that others (and your future self) can easily understand the purpose and reasoning behind your work.

Core Features & Use Cases

Folder READMEs: Explains the purpose and mental model of a directory, including diagrams and overviews of key exports.
JSDoc Comments: Documents when and why to use code elements, with examples, focusing on public APIs.
Code Comments: Explains the "why" behind non-obvious code logic, workarounds, or complex decisions.
Use Case: When documenting a new utils folder, create a README that explains its general purpose and provides a high-level overview of the types of utility functions it contains, rather than just listing each file.

Quick Start

Write a README for the components folder explaining its purpose and structure.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I write a README for a project folder that explains its structure?▼

To write a folder README, explain the directory's purpose and mental model, including diagrams and overviews of key exports. Focus on the "why" behind the project structure rather than just listing files.

How do I write JSDoc comments that explain when and why to use a function?▼

Write JSDoc comments that document when and why to use code elements, including examples. Focus on public APIs and explaining the reasoning behind the code for clarity and maintainability.

What is the best way to document non-obvious code logic and workarounds?▼

The best way to document non-obvious code logic is using concise code comments. Explain the "why" behind complex decisions and workarounds rather than just describing what the code does.

When do I need to add documentation to my codebase for developer experience?▼

You need to add documentation when others or your future self must easily understand the purpose and reasoning behind your work. Focus on explaining the mental model of directories and detailed public APIs.

Should code comments explain what the code does or why it was written?▼

Code comments should explain why the code was written, not what it does. Focus on clarifying non-obvious logic, complex decisions, and workarounds to ensure long-term maintainability.