red-hat-docs

Solid

Draft, rewrite, or audit modular enterprise technical documentation using an independently expressed interpretation of the Red Hat supplementary style guide. Use for administration, installation, configuration, security, troubleshooting, procedures, concepts, and references that must be precise, reusable, and supportable across product versions.

AI & Automation 60 stars 2 forks Updated 2 weeks ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
59
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Red Hat docs Create modular enterprise documentation that makes prerequisites, system state, actions, and verification explicit. ## Preserve product accuracy - Keep product names, versions, commands, files, paths, options, UI labels, and supported configurations exact. - Do not generalize a tested configuration into universal support. - Separate required, recommended, optional, deprecated, and unsupported behavior. - Ask for missing privilege, platform, version, and persistence facts. ## Build one module at a time Choose one dominant module type: - Concept: provide the mental model and relationships needed for later decisions. - Procedure: state prerequisites, perform one goal-directed sequence, and verify it. - Reference: present facts, options, syntax, or limits in a consistent lookup form. - Troubleshooting: identify a symptom, diagnostic evidence, cause, and recovery. Do not mix several independent goals in one procedure. Link modules into a larger assembly when a workflow needs multiple goals. ## Write direct technical prose - Address the reader as `you` only when they act. Name the system or component when it acts. - Prefer active voice and concrete verbs. Avoid hiding actions inside abstract nouns. - Keep terminology stable and match authoritative product capitalization. - Put a condition before an instruction when the reader must check it first. - State scope: host, cluster, namespace, user, service, session, or persistent configuration. - Use literal, ...

Details

Author
Neeeophytee
Repository
Neeeophytee/agent-stylebooks
Created
3 weeks ago
Last Updated
2 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category