AgentSkillsCN

markdown-for-project

在doc/文件夹中，围绕日志、实验、问题与知识，构建项目文档工作流。适用于以下场景：(1) 完成任何代码变更或任务时（添加日志）；(2) 运行模拟、测试或调查时（添加实验）；(3) 遇到错误、Bug或意外行为时（添加问题）；(4) 捕获领域知识或参考资料时（添加知识）；(5) 在doc/中创建或编辑任何.md文件时。每条记录都以独立文件形式保存，并配备兼容Obsidian的Frontmatter。

SKILL.md
--- frontmatter
name: markdown-for-project
description: Project documentation workflow for logs, experiments, issues, and knowledge in the doc/ folder. Use when (1) completing any code change or task (add log), (2) running simulations, tests, or investigations (add experiment), (3) encountering errors, bugs, or unexpected behavior (add issue), (4) capturing domain knowledge or reference material (add knowledge), (5) creating or editing any .md file in doc/. Each entry is its own file with Obsidian-compatible frontmatter.

Markdown for Project

Project documentation lives in doc/. Each entry is a separate file in its own subdirectory:

SubdirectoryWhen to createNaming pattern
doc/logs/After ANY code change or task<topic>.md
doc/experiments/When running simulations/tests<topic>.md
doc/issues/When encountering bugs/errors<topic>.md
doc/knowledge/When capturing domain knowledge, concepts, or reference material<topic>.md

Workflow

  1. •Do the work
  2. •After completing, create a new file in the appropriate subdirectory
  3. •If experiments were run, create a file in doc/experiments/
  4. •If issues were found, create a file in doc/issues/
  5. •If domain knowledge or reference material was gathered, create a file in doc/knowledge/

Frontmatter (Obsidian)

Every .md file in doc/ must have this frontmatter:

yaml
---
id: <uuid-v4>
name: <note-name>
description: <brief description>
type: <experiment|issue|knowledge|log|plan|notes|reference>
created: <YYYY-MM-DDTHH:MM:SS>
updated: <YYYY-MM-DDTHH:MM:SS>
tags: [tag1, tag2]
aliases: [alternate-name]
---

Generate UUID: python -c "import uuid; print(uuid.uuid4())" Get datetime: date +%Y-%m-%dT%H:%M:%S

File Naming

  • •All files: <topic>.md (lowercase, hyphenated, no spaces)
  • •Examples: reward-shaping.md, ppo-training-run.md, cpg-frequency-bug.md

Entry Templates

See references/templates.md for the exact format of log, experiment, and issue entries.

Linking

Use basic wikilinks only: [[note-name]]

Avoid: [[note|display]], [[note#heading]], ![[embed]]