Explains code paths and generates READMEs, inline comments, docstrings in Markdown format.
npx skills add https://github.com/k1lgor/virtual-company --skill doc-writer-k1lgor
Please help me install this Agent Skill. Skill: doc-writer Source: https://github.com/k1lgor/virtual-company/tree/main/skills/01-doc-writer Command: npx skills add https://github.com/k1lgor/virtual-company --skill doc-writer-k1lgor
Use this whenever the user asks to explain code, generate documentation, write a README, or add inline comments.
Ask the assistant to generate a README for the project.
High-intent search queries and answers about installing and using this skill.
To generate a README, the assistant analyzes your project's structure and produces Markdown-formatted sections following a standard README layout. It tailors the content to your specific project files and respects the target audience level.
Adding inline comments and docstrings is handled by analyzing your code and inserting language-aware documentation. The assistant generates language-appropriate docstrings and inline comments across various programming languages.
Yes, you can explain complex code paths by asking the assistant to summarize them. It breaks down intricate logic into clear, human-friendly explanations, making the codebase easier to understand for developers.
Generated technical documentation strictly follows Markdown formatting standards. It produces Markdown-formatted sections complete with language-appropriate docstrings and adheres to a standard README structure for software projects.
To document functions across different languages, the assistant applies language-aware rules to generate appropriate docstrings. It adapts the documentation style to match the specific syntax and conventions of the code's programming language.
coakenfoldGenerate Markdown documentation from source code and API references.
JongsixGenerate technical documentation from source code and API definitions.
kurtosis-techLint and format Kurtosis Starlark (.star) files for syntax and docstrings.
1337heroCreate beginner-friendly Markdown documentation for codebases using structured templates.
