36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
# Documentation guidelines for GoodGo project
|
|
|
|
> **Skill**: `documentation`
|
|
> **Compatibility**:
|
|
|
|
## Overview
|
|
|
|
Documentation guidelines for GoodGo project. Use for README, guides, architecture docs, or API docs. Ensures bilingual EN/VI consistency.
|
|
|
|
## When to Use
|
|
|
|
Use this skill when:
|
|
- Creating README files for services/packages / Tạo README cho services/packages
|
|
- Writing user guides and tutorials / Viết hướng dẫn sử dụng
|
|
- Documenting system architecture / Viết tài liệu kiến trúc hệ thống
|
|
- Creating API documentation / Tạo tài liệu API
|
|
- Writing operational runbooks / Viết runbooks vận hành
|
|
- Maintaining bilingual documentation / Duy trì tài liệu song ngữ EN/VI
|
|
|
|
## Quick Reference
|
|
|
|
For detailed patterns, code examples, and best practices, refer to the full skill documentation.
|
|
|
|
## Related Skills
|
|
|
|
See [Skills Index](./index.md) for related skills.
|
|
|
|
## Additional Resources
|
|
|
|
- **Full Skill Documentation**: [`...agent/skills/documentation/SKILL.md`](../../.agent/skills/documentation/SKILL.md)
|
|
- **Code Examples**: [`...agent/skills/documentation/references/REFERENCE.md`](../../.agent/skills/documentation/references/REFERENCE.md)
|
|
|
|
---
|
|
|
|
**Vietnamese Version**: [Tài liệu tiếng Việt](../../vi/skills/documentation.md)
|