wiki-auto-documenter

Community

Auto-document Python code to Azure DevOps Wiki.

Authorlinus-mcmanamey
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the laborious process of creating and maintaining comprehensive documentation for Python codebases in Azure DevOps Wiki. It ensures documentation is always synchronized with the codebase, follows strict formatting standards, and includes crucial details like code structure, dependencies, and cross-references, saving significant manual effort and improving developer onboarding.

Core Features & Use Cases

  • Multi-Agent Orchestration: Decomposes large documentation tasks into parallel sub-tasks for efficient processing.
  • Automated Code Analysis: Uses AST to extract classes, functions, docstrings, dependencies, and infer purpose from Python files.
  • Azure DevOps Wiki Integration: Publishes hierarchical wiki pages, including directory indexes and file-specific documentation, with bidirectional links to source code.
  • Strict Markdown Formatting: Enforces consistent markdown standards for readability and maintainability across all generated documentation.
  • Use Case: After a major refactor or when onboarding new team members, use this skill to automatically generate or update the entire project's Python codebase documentation in Azure DevOps Wiki, ensuring all new code is documented and existing docs are up-to-date.

Quick Start

Explain how to use the wiki-auto-documenter skill to document the 'python_files/gold/' directory, including the expected output and execution time.

Dependency Matrix

Required Modules

requestspandaspymupdfduckdblogururichtextualwatchdog

Components

scriptsreferencesassets

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: wiki-auto-documenter
Download link: https://github.com/linus-mcmanamey/multi-agent-user-story-development/archive/main.zip#wiki-auto-documenter

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository