Skip to main content

create-doc

Create or improve documentation based on the current conversation. Use this when a plan has been created and changes were requested because it didn’t follow the repository’s conventions. Use when this capability is needed.

跳到安装

来源信息

仓库
tomevault-io/tomes
最近来源活动
2026年7月23日 21:48
检测到的 SKILL.md 语言
英语
星标
1
分支
0

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
create-doc
description
Create or improve documentation based on the current conversation. Use this when a plan has been created and changes were requested because it didn’t follow the repository’s conventions. Use when this capability is needed.
metadata
{"author":"CodelyTV"}
Based on the current conversation, create new or improve existing documentation files inside the `docs/` folder. ## Steps 1. Identify conventions, patterns, or decisions discussed in the conversation that should be documented. 2. Check if a relevant doc already exists in `docs/` (organized by area: `backend/`, `frontend/`, `database/`, etc.). - If it exists, improve it while preserving the required structure. - If it does not exist, create a new file in the appropriate subfolder. 3. Read `docs/documentation-guidelines.md` and follow its structure exactly. Every document MUST include these sections in order: ``` # 🎯 Name of the convention ## 💡 Convention ## 🏆 Benefits ## 👀 Examples (with ✅ Good and ❌ Bad subsections) ## 🧐 Real world examples ## 🔗 Related agreements ``` 4. Ask the user to confirm the target file path before writing. 5. Update the AGENTS.md index with the new doc. ## Rules - Each convention goes in its own standalone Markdown file — never bundle multiple conventions into one doc. - Place files in the correct area subfolder (`backend/`, `frontend/`, `database/`, `testing/`, etc.). - Include concrete good and bad examples with code blocks when applicable. - Link to real files in the codebase that follow the convention in the "Real world examples" section. --- > Source: [CodelyTV/agentic_programming-course](https://github.com/CodelyTV/agentic_programming-course) — distributed by [TomeVault](https://tomevault.io). <!-- tomevault:4.0:skill_md:2026-06-23 -->
在 GitHub 查看