36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
# Documentation guidelines for GoodGo project
|
|
|
|
> **Skill**: `documentation`
|
|
> **Compatibility**:
|
|
|
|
## Tổng Quan
|
|
|
|
Documentation guidelines for GoodGo project. Use for README, guides, architecture docs, or API docs. Ensures bilingual EN/VI consistency.
|
|
|
|
## Khi Nào Sử Dụng
|
|
|
|
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
|
|
|
|
## Tham Chiếu Nhanh
|
|
|
|
Để biết chi tiết về patterns, code examples, và best practices, xem tài liệu skill đầy đủ.
|
|
|
|
## Skills Liên Quan
|
|
|
|
Xem [Danh Mục Skills](./index.md) để tìm skills liên quan.
|
|
|
|
## Tài Nguyên Bổ Sung
|
|
|
|
- **Tài Liệu Skill Đầy Đủ**: [`.agent/skills/documentation/SKILL.md`](../../.agent/skills/documentation/SKILL.md)
|
|
- **Ví Dụ Code**: [`.agent/skills/documentation/references/REFERENCE.md`](../../.agent/skills/documentation/references/REFERENCE.md)
|
|
|
|
---
|
|
|
|
**English Version**: [English Documentation](../../en/skills/documentation.md)
|