documentation

Write module READMEs and API documentation for the Luigi repository.

Updated Feb 9, 2026
One-click install
npx skills add https://github.com/pkathmann88/luigi --skill documentation-pkathmann88
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/pkathmann88/luigi/tree/main/.github/skills/documentation
Command: npx skills add https://github.com/pkathmann88/luigi --skill documentation-pkathmann88

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide to creating and maintaining high-quality documentation within the Luigi repository, ensuring consistency and clarity across all modules.

Core Features & Use Cases

  • Standardized READMEs: Learn the structure and best practices for module and main project READMEs.
  • API Documentation: Understand how to document APIs effectively as interface contracts.
  • Use Case: When developing a new Luigi module, use this Skill to ensure its README is complete, well-structured, and follows all project guidelines, making it easy for other users to understand and integrate.

Quick Start

Use the documentation skill to generate a README for a new Luigi module.

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 new Luigi module?

To write a README for a new Luigi module, follow Luigi's decentralized documentation standards to ensure clarity, completeness, and maintainability across module and project-level files.

What are Luigi's standards for API documentation?

Luigi's API documentation standards treat APIs as interface contracts, requiring comprehensive technical guides and adherence to best practices for clarity across the repository.

What is Luigi's decentralized documentation philosophy?

Luigi's decentralized documentation philosophy distributes technical writing across module READMEs and API documentation, ensuring maintainability and completeness without relying on a single central document.

What is the best way to structure technical guides for the Luigi repository?

The best way to structure technical guides for the Luigi repository involves applying standardized technical writing practices to ensure consistency, clarity, and completeness across all modules.

Do I need to follow specific guidelines to document a Luigi module?

Yes, documenting a Luigi module requires following specific project guidelines for READMEs and API documentation to guarantee the module is easily understood and integrated by other users.