skills.rest
LangConfig
LangConfigOFFICIAL
Explore all skills by this author →
WebsiteGitHub

documentation

Generate Markdown READMEs, Google-style Python docstrings, and structured API references.

55|15|Updated Dec 1, 2025
Search Tags:#documentation#markdown#technical writing#readme#docstrings#api docs#code clarity
One-click install
npx skills add https://github.com/LangConfig/langconfig --skill documentation-langconfig
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/LangConfig/langconfig/tree/main/backend/skills/builtin/documentation
Command: npx skills add https://github.com/LangConfig/langconfig --skill documentation-langconfig

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing clear, comprehensive, and consistent documentation is often time-consuming and challenging, leading to outdated or confusing guides for users and developers. This Skill automates the process of generating and improving various documentation types.

Core Features & Use Cases

  • Structured READMEs: Generate well-organized project READMEs with essential sections like features, installation, and usage.
  • Code Documentation: Get expert guidance for writing Python docstrings (Google Style) and TypeScript JSDoc, ensuring code clarity.
  • API Reference Generation: Create detailed API documentation for REST endpoints, including parameters, responses, and status codes.
  • Use Case: You've just finished a new microservice and need a comprehensive README. Use this Skill to generate a structured README, including installation steps, API endpoints, and usage examples, saving you hours of manual writing and formatting.

Quick Start

Help me write a README for my new Python project. It has a FastAPI backend and a React frontend.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write clear API documentation for REST endpoints?▼

API documentation should include endpoint paths, HTTP methods, parameters with types, response schemas, and status codes. Structure each endpoint with a description, request/response examples, and error cases to help developers integrate quickly and reduce support questions.

What should a README include for a new project?▼

A README should cover project purpose, installation steps, configuration, usage examples, and API endpoints if applicable. Well-organized READMEs with these sections reduce onboarding time and answer the most common developer questions upfront.

How do I document Python code with docstrings?▼

Google-style Python docstrings describe function purpose, parameters, return values, and exceptions in a consistent format. Properly documented code improves maintainability, enables IDE autocompletion, and makes it easier for contributors to understand your codebase.

Can I generate documentation for both frontend and backend code?▼

Yes. Documentation spans backend code (Python docstrings, API references), frontend code (TypeScript JSDoc), and project-level guides (READMEs, installation). This unified approach keeps all documentation types consistent and centralized.

What's the best way to document deprecations and versioning?▼

Include deprecation notices in docstrings and API references with migration paths, and maintain versioning notes in READMEs or changelog sections. Clear deprecation information prevents users from relying on outdated features and reduces confusion during upgrades.

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
modu-aimodu-ai
1.2k

moai-docs-generation

Generate API documentation from source code with multi-format outputs.

Official
Advanced
paulojalowyjpaulojalowyj
6

lint-and-validate

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

Community
Intermediate
soo-kate-yeonsoo-kate-yeon

moai-docs-generation

Generate API documentation from source code and OpenAPI specifications.

Community
Advanced