skills.rest
dtbuchholz
dtbuchholzCOMMUNITY
Explore all skills by this author →
Website𝕏@dtbuchholzGitHub

documentation

Write inline comments, docstrings, and README files for code documentation.

Updated Jan 22, 2026
Search Tags:#best practices#documentation#readme#code comments#docstrings#api documentation
One-click install
npx skills add https://github.com/dtbuchholz/claude-config --skill documentation-dtbuchholz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/dtbuchholz/claude-config/tree/main/skills/documentation
Command: npx skills add https://github.com/dtbuchholz/claude-config --skill documentation-dtbuchholz

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you create clear, effective, and maintainable documentation for your code, ensuring better understanding and easier maintenance.

Core Features & Use Cases

  • Inline Comments: Guidance on when and how to add comments to complex logic.
  • Function Documentation: Best practices for docstrings in various languages (Python, TypeScript, Go, Rust).
  • Project-Level Docs: Structure and content recommendations for README files and API documentation.
  • Use Case: You've just finished a complex algorithm and need to document it thoroughly. This Skill will guide you on writing precise docstrings and inline comments to explain its purpose, parameters, and logic.

Quick Start

Use the documentation skill to generate a Python docstring for the following function.

Frequently Asked Questions about documentation

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

FAQPage Schema
What is the best way to write code documentation for complex algorithms?▼

The best way to write code documentation is through clear inline comments, function docstrings, and project-level README files. This practice ensures better understanding and easier maintenance across multiple programming languages.

How do I write effective docstrings for Python and TypeScript functions?▼

To write effective docstrings for Python and TypeScript functions, follow best practices for clarity and maintainability to explain the function's purpose, parameters, and return values. This ensures your code intent is easily understood.

When do I need inline comments versus project-level README files?▼

You need inline comments when adding guidance to complex logic, whereas project-level README files provide structure and content recommendations for overall project understanding. Both are necessary for comprehensive code documentation.

Does this documentation guidance cover API documentation and architectural decisions?▼

Yes, this documentation guidance covers API documentation and architectural decisions. It provides recommendations for structuring API docs and addressing architectural choices to maintain clarity across your software engineering projects.

Can I use these documentation best practices for Go and Rust projects?▼

Yes, you can use these documentation best practices for Go and Rust projects. The guidance covers function documentation and docstring conventions across multiple languages including Python, TypeScript, Go, and Rust.

Related Skills

Explore More Software Engineering Skills→
Selfdb-ioSelfdb-io

code-documentation

Generate docstrings, README files, API docs, and architecture overviews from source code.

Community
Intermediate
SSiertsemaSSiertsema

documentation-tooling-selection

Evaluate documentation tooling against audience, content, and technical criteria.

Community
Advanced
MolcajeteAIMolcajeteAI
2

pre-commit-hooks

Configure Husky and lint-staged pre-commit hooks for automated code quality checks.

Official
Intermediate
shenjingnanshenjingnan
333

api-docs

Generate MDX API documentation from TypeScript/JavaScript source code using decorators and comments.

Community
Intermediate