doc-writer

Generate Google-style Python docstrings and Markdown documentation for software projects.

12|3|Updated Jun 17, 2026
One-click install
npx skills add https://github.com/phuhao00/bony-agent --skill doc-writer-phuhao00
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/phuhao00/bony-agent/tree/main/.agent/skills/doc-writer
Command: npx skills add https://github.com/phuhao00/bony-agent --skill doc-writer-phuhao00

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the manual effort of writing repetitive technical documentation, ensuring your codebase remains well-documented and easy to maintain.

Core Features & Use Cases

  • Python Docstrings: Automatically generates Google-style docstrings for functions, classes, and modules.
  • Markdown Documentation: Creates structured README sections or standalone technical guides.
  • Use Case: When you finish writing a complex utility function, use this Skill to generate a complete docstring including arguments, return types, and potential exceptions.

Quick Start

Use the doc-writer skill to generate Google-style docstrings for the provided Python function code.

Frequently Asked Questions about doc-writer

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

FAQPage Schema
How do I generate Google-style Python docstrings for functions automatically?

To generate Google-style Python docstrings, provide your Python function code to the documentation generator. It outputs standardized docstrings detailing arguments, return values, and exception handling.

What is the best way to create technical Markdown documentation for a Python project?

The best way to create technical Markdown documentation is using an automated generator that reads your Python code. It produces structured README sections and standalone technical guides for software maintenance.

Can I document Python exception handling and return types without writing manually?

Yes, you can document Python exception handling and return types without manual effort. The tool analyzes provided function code to automatically populate complete, standardized docstrings with these details.

Does automated Python docstring generation work for both classes and modules?

Automated Python docstring generation works for classes, modules, and functions. It applies Google Style guide requirements to ensure consistent, readable code documentation across your entire codebase.

Why should I use standardized docstrings for Python code maintenance?

You should use standardized docstrings for Python code maintenance because they eliminate repetitive manual writing. Consistent Google-style documentation ensures the codebase remains readable and easy to maintain.