document

Enforce Markdown documentation standards with defined structure and rules.

2|1|Updated Jan 12, 2026
One-click install
npx skills add https://github.com/Wulnut/lark_agent --skill document-wulnut
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/Wulnut/lark_agent/tree/main/.opencode/skill/document
Command: npx skills add https://github.com/Wulnut/lark_agent --skill document-wulnut

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Markdown 文档的编写规范与结构规划,帮助团队提升文档的一致性、可维护性和可发现性。

Core Features & Use Cases

  • 提供统一的目录结构指南(README、docs/、guide/、api/、examples/),确保项目文档易于导航。
  • 规定文档版本控制与变更记录规范(CHANGELOG.md,遵循语义化版本控制),便于追踪演变。
  • 提供文档组织与示例代码规范,确保内容简洁、易读、语言统一,适用于新项目启动和现有仓库审计。
  • 适用场景包括设定文档规范、进行代码审查以提升文档质量、以及团队培训以统一写作风格。

Quick Start

Follow the defined structure and update the root README.md to reflect the project guidelines.

Frequently Asked Questions about document

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

FAQPage Schema
How do I standardize Markdown documentation across multiple projects?

Establishing a Markdown documentation standard involves defining directory structures like README and docs/, enforcing writing standards, and maintaining a CHANGELOG.md for version tracking. This approach ensures project documentation remains easy to navigate and maintain across teams.

What is the best way to structure a README and docs directory for maintainability?

A maintainable docs directory uses a standardized structure with README, docs/, guide/, and examples/ folders. Applying documentation version control and consistent language ensures the content is concise, readable, and easy to navigate for developers.

Does this Markdown style guide support auditing existing repositories?

Yes, the documentation standards apply to auditing existing repositories by checking Markdown content against defined structural rules. You can review README files, docs folders, and code examples to ensure they comply with specified frontmatter and writing standards.

How do I manage documentation version control and change logs?

You manage documentation version control by implementing a CHANGELOG.md that adheres to semantic versioning. This provides a clear record of updates, ensuring teams can track the evolution of project documentation and maintain consistency across revisions.

Can I use these writing standards for team training to unify documentation style?

These writing standards are suitable for team training, providing defined rules for Markdown authoring and code review. By establishing a clear style guide, teams can unify their writing approach and improve overall document quality and consistency.