GaZmagik/iso-24495 / skills/iso-24495-5
iso-24495-5
FlaggedProvisional sector-specific Plain Language standard for document design (based on ISO/WD 24495-5, under development). Applied when structuring complex documents so readers can find and navigate content through layout, visual hierarchy, and navigation aids.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 14.5 KB |
| agents/openai.yaml | config | 283 B |
| assets/adr-template.md | markdown | 1.2 KB |
| assets/design-doc-template.md | markdown | 2.7 KB |
| assets/runbook-template.md | markdown | 741 B |
| tests/fixtures/pinned-documents.ts | script | 198.8 KB |
| tests/reference/build-pinned-documents.ts | script | 2.4 KB |
| tests/reference/shipped-documents.ts | script | 2.5 KB |
| tests/repository-conventions.test.ts | script | 107.1 KB |
| tests/skill-frontmatter.test.ts | script | 4.0 KB |
| tests/templates.test.ts | script | 17.9 KB |
assets/design-doc-template.md
View on GitHub# [Project Name] Design Document
- **Purpose:** [What the reader can build or review from this, and what it covers, in one sentence.]
- **For:** [Who this design is written for.]
- **Version:** [Version or date.]
- **Instead of this:** [Link the design that may suit the reader better and say when to read it, or delete this line.]
## Contents
[Reviewers cite these sections by number, which is why they are numbered. Where nobody cites yours, delete the numbers from the headings and from this contents list together.]
- [1. Summary](#1-summary)
- [2. System Architecture](#2-system-architecture)
- [3. Data Model](#3-data-model)
- [4. API Design](#4-api-design)
- [5. Security Model](#5-security-model)
- [6. Deployment Plan](#6-deployment-plan)
## 1. Summary
[Summarise the reader need, the proposed design and the expected outcome. Say what the reader must do next. Name any condition that changes the decision, and any qualification a reader must respect, whether legal, financial or an approval.]
## 2. System Architecture
### 2.1. What each component is responsible for
[Insert a diagram with a text alternative, or a summary table naming each component and its responsibility.]
### 2.2. How a request flows through the system
[Describe the main request and response flow.]
#### 2.2.1. How a sign-in is checked
[Describe sign-in, token validation, and failure handling.]
## 3. Data Model
### 3.1. Entities and Relationships
[Name the narrowest width each table must survive, then read them back at that width. Where no width is known, use labelled records instead.]
| Entity | Purpose | Relationships |
| :--- | :--- | :--- |
| **[Entity]** | [Purpose] | [Related entities] |
### 3.2. How data enters, changes and leaves
[Describe how data enters, changes, persists, and leaves the system.]
## 4. API Design
### 4.1. Endpoints
| Method | Path | Purpose | Request | Response |
| :--- | :--- | :--- | :--- | :--- |
| `[METHOD]` | `[path]` | [Purpose] | [Request shape] | [Response shape] |
### 4.2. Error Handling
[Define error categories, response shapes, and retry behaviour.]
## 5. Security Model
### 5.1. Threats and Controls
| Threat | Control | Residual risk |
| :--- | :--- | :--- |
| **[Threat]** | [Control] | [Residual risk] |
### 5.2. Access Control
[Define roles, permissions, and enforcement points.]
## 6. Deployment Plan
### 6.1. Environments
[Describe each environment and its release criteria.]
### 6.2. How the change ships and how it comes back
1. [Prepare and verify the release.]
2. [Deploy the change in controlled stages.]
3. [Check the release against the criteria in 6.1.]
| Check result | What to do |
| :--- | :--- |
| **[Criteria met]** | [Finish the release and record it.] |
| **[Criteria not met]** | [Follow the rollback procedure.] |
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 323k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |