doc-writer

Generate and incrementally update Markdown project documentation from project structure and build files.

8|1|Updated Jun 12, 2018

Search Tags:#documentation #markdown #confluence #README #project docs

Ready to run

npx skills add https://github.com/SheTieJun/BaseKit --skill doc-writer-shetiejun

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-writer
Source: https://github.com/SheTieJun/BaseKit/tree/main/.trae/skills/doc-writer
Command: npx skills add https://github.com/SheTieJun/BaseKit --skill doc-writer-shetiejun

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

该技能自动为当前项目生成或增量更新 README 与技术文档，帮助省去重复撰写的时间。

Core Features & Use Cases

自动从项目结构和关键文件中提取信息，生成项目简介、架构概览、快速开始等内容。
支持对已有文档的增量更新，不覆盖现有手动内容，仅新增或更新相关段落。
输出默认 Markdown 格式，便于直接集成到仓库或文档站点。

Quick Start

使用 doc-writer 自动为当前项目生成文档，或对选定文件进行文档更新。

Frequently Asked Questions about doc-writer

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

FAQPage Schema

How do I automatically generate project README and technical docs from source code?▼

Yes, incremental updating of existing project documentation is supported. When existing docs are present, the tool updates relevant paragraphs without overwriting your manual content, only adding or modifying the necessary sections.

Can I extract dependencies from build.gradle and libs.versions.toml for documentation?▼

You can extract dependencies from build.gradle, build.gradle.kts, and libs.versions.toml files for documentation. The tool parses these build files to identify project dependencies and includes them in the generated technical docs.

What is the best way to create architecture overviews and structure diagrams for a multi-module software project?▼

Creating architecture overviews and structure diagrams for multi-module projects is done by analyzing the project structure. The tool detects main entry points and module relationships to automatically generate these visual representations in Markdown.

Does the auto-generated Markdown documentation work with Confluence and documentation sites?▼

The auto-generated Markdown documentation works with Confluence and documentation sites. Outputting in default Markdown format ensures the generated README and technical docs can be directly integrated into repositories or web-based documentation platforms.

What are the limitations of auto-generating technical docs for selected files in a software project?▼

Limitations of auto-generating technical docs include relying on detectable project structures and build files for extraction. If selected files lack clear entry points or standard build configurations, the generated architecture overview may be incomplete.