{
  "markdown": "# Simplified Technical English (`ste-writing-style`)\n\n[![ASD-STE100 Compliant](https://img.shields.io/badge/Standard-ASD--STE100-blue.svg)](https://www.asd-ste100.org/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n[![Gemini / Antigravity Extension](https://img.shields.io/badge/Extension-Gemini%20%2F%20Antigravity-green.svg)](#installation)\n\nA collection of skills and tools for writing, auditing, and managing technical documentation according to **[ASD-STE100 Simplified Technical English (STE)](https://www.asd-ste100.org/)**. Designed for AI coding assistants (Gemini, Jetski, Antigravity).\n\n---\n\n## Features\n\n- **ASD-STE100 Compliance**: Strict enforcement of controlled vocabulary, active voice, sentence length limits (≤20 words for instructions, ≤25 words for descriptions), simple tenses, and noun stacks (≤3 nouns).\n- **Dual OKF 2.0 & AI Agent Frontmatter**: All skills are fully compliant with both the Open Knowledge Format (OKF 2.0 / 0.2) concept specification and Antigravity / Gemini CLI skill standards.\n- **Extensible Dictionary System**: Define domain-specific **Technical Names (TN)** and **Technical Verbs (TV)** at both the project repository level (`.ste-dictionary.yaml`) and individual document level (`ste_vocabulary:` YAML frontmatter).\n- **Automated Vocabulary Discovery**: Cross-references the [`information-architecture`](https://github.com/dandye/information-architecture) skill suite (`vocabulary-overlap-analysis`, `thesaurus-generate`) to harvest domain terms from your codebase and auto-populate your STE dictionary.\n- **Automated STE Auditing**: Run comprehensive compliance audits on Markdown files, PRs, and runbooks with line-by-line violation reports and suggested rewrites.\n\n---\n\n## Repository Structure\n\n```text\n.\n├── README.md                          # Repository overview & usage guide\n├── GEMINI.md                          # Agent instructions & command bindings\n├── AGENTS.md                          # Agent instructions for Antigravity agents\n├── gemini-extension.json              # Extension manifest\n├── LICENSE                            # MIT License\n└── skills/\n    ├── ste-writing-style/             # Core STE writing & refactoring skill\n    │   ├── SKILL.md\n    │   ├── references/\n    │   │   ├── ste-grammar-rules.md   # Complete ASD-STE100 rule reference\n    │   │   ├── ste-general-dictionary.md # Approved core words & forbidden replacements\n    │   │   └── dictionary-schema.md   # Extensible dictionary schema & frontmatter specs\n    │   └── examples/\n    │       ├── before-after-rewrites.md # Real-world before/after refactoring examples\n    │       └── project-dictionary-example.yaml # Sample extended project dictionary\n    ├── ste-audit/                     # Compliance audit skill\n    │   └── SKILL.md\n    └── ste-dictionary-generate/       # Automated dictionary generator skill\n        └── SKILL.md\n```\n\n---\n\n## Skills & Commands\n\n| Command | Skill | Description |\n| :--- | :--- | :--- |\n| `/ste:write` / `/ste:rewrite` | **[`ste-writing-style`](skills/ste-writing-style/SKILL.md)** | Refactor technical prose into ASD-STE100 Simplified Technical English. |\n| `/ste:audit` | **[`ste-audit`](skills/ste-audit/SKILL.md)** | Run a rule-by-rule STE audit on Markdown documents and produce an audit report. |\n| `/ste:dict-gen` | **[`ste-dictionary-generate`](skills/ste-dictionary-generate/SKILL.md)** | Auto-extract project terms from source code/docs and generate `.ste-dictionary.yaml`. |\n\n---\n\n## Extensible Dictionary & Resolution Hierarchy\n\nSTE requires controlled vocabulary while allowing technical domain terms. This skill resolves approved words using a 3-tier **Priority Hierarchy**:\n\n```mermaid\ngraph TD\n    A[\"1. Document YAML Frontmatter (ste_vocabulary:)\"] -->|Overrides| B[\"2. Project Dictionary (.ste-dictionary.yaml)\"]\n    B -->|Overrides| C[\"3. Core ASD-STE100 Dictionary\"]\n    C --> D[\"Effective Approved Vocabulary\"]\n```\n\n### 1. Document Frontmatter Overrides (`ste_vocabulary:`)\nDeclare file-specific Technical Names or Verbs right in your Markdown header:\n```yaml\n---\ntitle: Ingress Controller Configuration\nste_vocabulary:\n  technical_names:\n    - \"ingress controller\"\n    - \"TLS certificate\"\n  technical_verbs:\n    - \"terminate\"\n  allowed_overrides:\n    - word: \"route\"\n      reason: \"Approved domain action verb in Kubernetes context\"\n---\n```\n\n### 2. Project Repository Dictionary (`.ste-dictionary.yaml`)\nPlace `.ste-dictionary.yaml` in your repository root for shared domain terms across all docs:\n```yaml\nversion: \"1.0\"\nproject: \"CloudPlatform\"\n\ntechnical_names:\n  - term: \"cluster\"\n    category: \"software\"\n    definition: \"Set of worker nodes that run containerized applications.\"\n\ntechnical_verbs:\n  - term: \"deploy\"\n    definition: \"Install and start an application on a cluster.\"\n\nforbidden_project_words:\n  - word: \"spin up\"\n    replacement: \"start\"\n```\n\n---\n\n## Cross-Reference with `information-architecture`\n\nThis extension works seamlessly alongside [`dandye/information-architecture`](https://github.com/dandye/information-architecture):\n\n1. Run `/ia:vocab-overlap` (`vocabulary-overlap-analysis`) to scan your codebase or documentation corpus for unique entities, product terms, and jargon.\n2. Run `/ia:thesaurus` (`thesaurus-generate`) to map variants to canonical preferred terms.\n3. Run `/ste:dict-gen` (`ste-dictionary-generate`) to convert the output into a formatted `.ste-dictionary.yaml`.\n\n---\n\n## Installation\n\n### Option A: Install into Local Agent Customizations (`.agents/skills/`)\nClone or copy the `skills/` directory into your project's `.agents/skills/` folder:\n```bash\nmkdir -p .agents/skills\ncp -r skills/* .agents/skills/\n```\n\n### Option B: Install Globally (`~/.gemini/config/skills/`)\nCopy the skills to your global configuration directory:\n```bash\nmkdir -p ~/.gemini/config/skills\ncp -r skills/* ~/.gemini/config/skills/\n```\n\n---\n\n## License\n\nDistributed under the MIT License. See [`LICENSE`](LICENSE) for details.\n",
  "bytes": 5985,
  "sha": "f41e6125f863e9430edaea19c77c7f98c893e55ff050ea7ad33616a3fdac7f87",
  "repo_slug": "dandye/ste-writing-style",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/plg_dandye_ste_writing_style_ca66ecab/readme"
}