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
- 포크
- 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에서 보기