documentation-standards
Standards for technical documentation, C4 architecture models, and Mermaid diagrams following Hack23 guidelines
来源信息
- 仓库
- Hack23/riksdagsmonitor
- 最近来源活动
- 2026年4月16日 09:31
- 检测到的 SKILL.md 语言
- 英语
- 星标
- 13
- Forks
- 3
安装方式
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
检查来源文件
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
正在显示 SKILL.md
SKILL.md
来源说明 · 只读预览- name
- documentation-standards
- description
- Standards for technical documentation, C4 architecture models, and Mermaid diagrams following Hack23 guidelines
- license
- Apache-2.0
# Documentation Standards Skill
## 🔴 AI FIRST Quality Principle
> **Apply the AI FIRST principle: never accept first-pass quality. Minimum 2 iterations. Read all output, improve every section. No shortcuts.**
## Purpose
Ensure consistent, high-quality technical documentation following C4 architecture model and Hack23 standards.
## Document Structure Template
```markdown
# Title - [Purpose]
**Document Version:** X.X
**Last Updated:** YYYY-MM-DD
**Classification:** [Public/Internal]
**Owner:** Hack23 AB (Org.nr 5595347807)
## Executive Summary
[High-level overview]
## 1. Main Content
[Sections with diagrams]
## Related Documentation
[Links to related docs]
---
**Document Control:**
- **Repository:** [URL]
- **Path:** /DOCUMENT.md
- **Format:** Markdown with Mermaid
- **Next Review:** YYYY-MM-DD
```
## C4 Architecture Model
### Level 1: System Context
```mermaid
graph TB
User[Users]
System[System]
External[External System]
User --> System
System --> External
```
### Level 2: Container
```mermaid
graph TB
subgraph "System"
App[Application]
DB[Database]
end
User --> App
App --> DB
```
### Level 3: Component
```mermaid
graph TB
subgraph "Application"
Controller[Controller]
Service[Service]
Repository[Repository]
end
```
## Mermaid Diagram Best Practices
1. Use clear, descriptive labels
2. Consistent styling with subgraphs
3. Appropriate diagram types
4. Color coding for clarity
5. Legend when needed
## Remember
- **Clarity First**: Easy to understand
- **Consistency**: Follow standards
- **Visual**: Use diagrams
- **Completeness**: All required docs
- **Maintenance**: Regular reviews
## References
- [C4 Model](https://c4model.com/)
- [Mermaid](https://mermaid.js.org/)
在 GitHub 查看