Markdown
Markdown formats plain text with small marks. Those marks create headings, lists, links, and code blocks.
Another example
A team writes one README. GitHub formats it, while terminals and code reviews still show readable text.
Main parts
- 01Code or behavior under test
- 02Observable evidence
- 03Coverage, failure, and recovery
Use it when
Use it for guides, issue templates, release notes, or structured AI prompts.
Do not use it when
Avoid platform-only extensions when the text must look consistent in several tools.
Name used in code
CommonMark / GitHub Flavored Markdown Before you ship
Check the runtime and version, integration limits, dependencies and licenses, and platform support. Verify security, failure, speed, monitoring, deploy, support owner, upgrade path, and rollback.
Outcome: Use or review Markdown as a technical building block that the team can maintain. User context: A team writes one README. GitHub formats it, while terminals and code reviews still show readable text. Technology or engineering concept: Markdown. Why it fits: Use it for guides, issue templates, release notes, or structured AI prompts. Do not use it when: Avoid platform-only extensions when the text must look consistent in several tools. Engineering fit: Define where it runs and which version to use. Set its job, interfaces, data flow, dependencies, supported systems, security, and speed limits. Explain how it fits the current stack. Lifecycle safeguards: Check dependency health and licenses. Add monitoring and a fallback. Name the upgrade owner. Do not add a second tool for the same job without a measured benefit. Acceptance criteria: A small integration proves the needed behavior. Test compatibility, security, failure, and performance. Document deploy, upgrade, support, and rollback steps. Evidence and limits (evidence boundary): A formal document may still be a draft, release candidate, or final version. Check its status and browser or platform support. Unknowns to confirm: Current stack, runtime and version rules, target systems, dependency owner, performance budget, support period, and migration limits.
Check this request
Review the current use of Markdown. Definition: Markdown formats plain text with small marks. Those marks create headings, lists, links, and code blocks. Release checks: Check the runtime and version, integration limits, dependencies and licenses, and platform support. Verify security, failure, speed, monitoring, deploy, support owner, upgrade path, and rollback. Before changing code, report the evidence you found, gaps, severity, and the smallest safe fix.