admonition-rules

Enforce MIL-STD-38784B-adapted admonition guidelines in AsciiDoc documentation.

Updated Dec 4, 2025

Search Tags:#documentation #style-guide #documentation-review #admonition #mil-38784b #ascii doc

Ready to run

npx skills add https://github.com/jamieadams-nerd/umrs-project --skill admonition-rules

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: admonition-rules
Source: https://github.com/jamieadams-nerd/umrs-project/tree/main/.claude/skills/admonition-rules
Command: npx skills add https://github.com/jamieadams-nerd/umrs-project --skill admonition-rules

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill ensures consistent application of admonition blocks (WARNING, CAUTION, NOTE, etc.) across UMRS documentation, reducing mislabeling and miscommunication.

Core Features & Use Cases

Admonition hierarchy mapping: defines when to use WARNING, CAUTION, IMPORTANT, NOTE, and TIP based on potential impact.
Trigger-based guidance: provides automated prompts when authors mention or insert admonitions in AsciiDoc files under docs/.
Compliance checks: validates correct level selection and placement according to MIL-STD-38784B adaptation for software documentation.

Quick Start

Apply the correct admonition level to every relevant section in your AsciiDoc files using the MIL-STD-38784B hierarchy.

Frequently Asked Questions about admonition-rules

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I enforce consistent AsciiDoc admonitions in documentation?▼

Admonition hierarchy mapping defines when to use specific labels like WARNING, CAUTION, IMPORTANT, NOTE, and TIP based on potential impact severity. This standardizes warnings and notes, reducing mislabeling and miscommunication in software documentation.

When should I use a warning versus a caution in technical documentation?▼

Use warnings for higher potential impact situations and cautions for lower impact, guided by the MIL-STD-38784B adapted hierarchy. This ensures correct level selection and placement for clear, standardized communication in your documentation.

How do I validate AsciiDoc admonition placement during a documentation review?▼

Validate AsciiDoc admonition placement using trigger-based compliance checks during authoring or reviewing. This validates correct level selection and placement according to MIL-STD-38784B adaptation, ensuring consistent labeling across your documentation files.

Does the MIL-STD-38784B admonition standard work with AsciiDoc files?▼

Yes, the MIL-STD-38784B adapted guidelines work directly with AsciiDoc files under the docs/ directory. The standard requires no external tooling to enforce consistent warning, caution, note, and tip labeling during authoring.

What are the limitations of using automated prompts for documentation style guide enforcement?▼

The limitation of automated style guide prompts is that triggers only activate when admonition terms appear in AsciiDoc files under docs/. The scope is restricted to labeling, placement, and level selection, excluding broader style guide or formatting compliance.