skills.rest
kongliuli
kongliuliCOMMUNITY
Explore all skills by this author →
GitHub

documentation-engineer

Generate and maintain XML/Docstring annotations, READMEs, API references, and changelogs for C# and Python projects.

Updated Aug 23, 2026
Search Tags:#documentation#README#CHANGELOG#API-docs#XML-comments#Docstring#C#-Python
One-click install
npx skills add https://github.com/kongliuli/VibeSkills --skill documentation-engineer-kongliuli
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-engineer
Source: https://github.com/kongliuli/VibeSkills/tree/main/Skills/%E9%80%9A%E7%94%A8Skills/documentation-engineer
Command: npx skills add https://github.com/kongliuli/VibeSkills --skill documentation-engineer-kongliuli

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the creation and maintenance of code documentation by generating XML/Docstring annotations, README content, API references, and changelogs across C# and Python projects.

Core Features & Use Cases

  • XML/Docstring annotation generation: Produce consistent code comments for C# and Python.
  • README and API documentation upkeep: Create and refresh project READMEs and API docs to reflect latest changes.
  • CHANGELOG automation: Maintain structured changelogs aligned with project releases.
  • Use Case: Apply to a new or evolving project to keep docs synchronized with code and changes.

Quick Start

Example prompts:

  • Generate XML/Docstring comments for a given C# class, create a README, and update API documentation.
  • Update the project's CHANGELOG based on the latest commits and code changes.

Frequently Asked Questions about documentation-engineer

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

FAQPage Schema
How do I generate XML comments and Docstrings for C# and Python code?▼

XML comments and Docstrings for C# and Python are generated by analyzing code structure to produce consistent annotations. This ensures standardized code documentation across projects without manual typing.

How do I automate README and API documentation updates from code changes?▼

README and API documentation updates are automated by reflecting the latest code changes into standardized templates. This keeps project documentation synchronized with evolving codebases.

What is the best way to maintain a CHANGELOG aligned with project releases?▼

Maintaining a CHANGELOG aligned with releases is handled by automatically structuring project changes into a standardized log. This tracks evolving code modifications consistently across versions.

Can I use this to generate API references for both C# and Python projects?▼

Yes, API references can be generated for both C# and Python projects. The skill enforces consistent frontmatter metadata and standardized templates to output structured API documentation.

Does this documentation automation tool require any specific dependencies?▼

No specific dependencies are required to run this documentation automation. It operates independently to enforce standardized templates and frontmatter metadata for code documentation tasks.

Related Skills

Explore More Software Engineering Skills→
VMRam95VMRam95

agentlens

Analyze directory structures and source code to generate hierarchical documentation and architectural maps.

Community
Intermediate
shalevaminshalevamin

code-documenter

Generate, format, and validate technical documentation including docstrings and OpenAPI specs.

Community
Intermediate
kurokeitakurokeita
1

changelog-automation

Automate changelog generation from commits, PRs, and releases.

Community
Intermediate
FaysilAlshareefFaysilAlshareef
4

api-docs

Enrich OpenAPI specifications with summaries, descriptions, and examples.

Community
Intermediate