Skip to content

foryourhealth111-pixel/Vibe-Skills / bundled/skills/markdown-mermaid-writing

markdown-mermaid-writing

Unverified

Comprehensive markdown and Mermaid diagram writing skill that establishes text-based diagrams as the DEFAULT documentation standard. Use this skill when creating ANY scientific document, report, analysis, or visualization — it ensures all outputs are in version-controlled, token-efficient markdown with embedded Mermaid diagrams as the source of truth, with clear pathways to downstream Python or AI-generated images. Includes full style guides (markdown + mermaid), 24 diagram type references, and 9 document templates ready to use.

FileKindSize
SKILL.mdskill md14.8 KB
assets/examples/example-research-report.mdmarkdown8.8 KB
references/diagrams/architecture.mdmarkdown4.3 KB
references/diagrams/block.mdmarkdown4.7 KB
references/diagrams/c4.mdmarkdown6.1 KB
references/diagrams/class.mdmarkdown8.3 KB
references/diagrams/complex_examples.mdmarkdown16.7 KB
references/diagrams/er.mdmarkdown7.4 KB
references/diagrams/flowchart.mdmarkdown6.8 KB
references/diagrams/gantt.mdmarkdown5.7 KB
references/diagrams/git_graph.mdmarkdown2.0 KB
references/diagrams/kanban.mdmarkdown3.5 KB
references/diagrams/mindmap.mdmarkdown2.2 KB
references/diagrams/packet.mdmarkdown1.7 KB
references/diagrams/pie.mdmarkdown1.5 KB
references/diagrams/quadrant.mdmarkdown2.1 KB
references/diagrams/radar.mdmarkdown2.1 KB
references/diagrams/requirement.mdmarkdown2.4 KB
references/diagrams/sankey.mdmarkdown2.1 KB
references/diagrams/sequence.mdmarkdown5.4 KB
references/diagrams/state.mdmarkdown5.3 KB
references/diagrams/timeline.mdmarkdown4.1 KB
references/diagrams/treemap.mdmarkdown2.0 KB
references/diagrams/user_journey.mdmarkdown4.9 KB
references/diagrams/xy_chart.mdmarkdown1.8 KB
references/diagrams/zenuml.mdmarkdown2.2 KB
references/markdown_style_guide.mdmarkdown34.3 KB
references/mermaid_style_guide.mdmarkdown25.8 KB
templates/decision_record.mdmarkdown7.0 KB
templates/how_to_guide.mdmarkdown6.9 KB
templates/issue.mdmarkdown12.5 KB
templates/kanban.mdmarkdown11.1 KB
templates/presentation.mdmarkdown7.9 KB
templates/project_documentation.mdmarkdown11.2 KB
templates/pull_request.mdmarkdown12.6 KB
templates/research_paper.mdmarkdown9.9 KB
templates/status_report.mdmarkdown7.0 KB

templates/status_report.md

View on GitHub
<!-- Source: https://github.com/SuperiorByteWorks-LLC/agent-project | License: Apache-2.0 | Author: Clayton Young / Superior Byte Works, LLC (Boreal Bytes) -->

# Status Report / Executive Briefing Template

> **Back to [Markdown Style Guide](../markdown_style_guide.md)** — Read the style guide first for formatting, citation, and emoji rules.

**Use this template for:** Weekly/monthly status updates, executive briefings, project health reports, quarterly reviews, sprint retrospectives, or any document that updates stakeholders on progress, risks, and decisions needed. Designed to be read in under 5 minutes by someone with decision-making authority.

**Key features:** TL;DR at the top for executives who won't read further, traffic-light health indicators, explicit "decisions needed" section that surfaces blockers, metrics table with trends, and risk register with mitigations.

**Philosophy:** The #1 failure mode of status reports is burying the important stuff in a wall of accomplishments. Lead with what needs attention. If the reader only has 30 seconds, the TL;DR and health summary give them what they need. If they have 5 minutes, the full report answers every follow-up question they'd ask. Never make leadership dig for the thing they need to act on.

---

## How to Use

1. Copy this file for each reporting period
2. Name it by date: `status-2026-02-14.md` or `status-week-07.md`
3. **Fill in the TL;DR first** — if you can't summarize it, you don't understand it yet
4. Be honest about health status — green means green, not "green because I'm optimistic"
5. Add [Mermaid diagrams](../mermaid_style_guide.md) for progress timelines, architecture changes, or risk impact flows

---

## The Template

Everything below the line is the template. Copy from here:

---

# [Project/Team Name] — Status Report

_[Reporting period: Week of Month DD, YYYY / Month YYYY / Q# YYYY]_
_[Author] · [Date]_

---

## 📋 TL;DR

[3–5 bullet points. One sentence each. The most important things leadership needs to know. If they read nothing else, this is it.]

- **Overall:** [One-sentence project health summary]
- **Progress:** [Key milestone hit or approaching]
- **Blocker:** [The biggest risk or decision needed, or "None" if clear]
- **Next:** [What happens in the next period]

---

## 🚦 Health Summary

| Area         | Status       | Trend | Notes                     |
| ------------ | ------------ | ----- | ------------------------- |
| **Schedule** | 🟢 On track  | →     | [Brief context]           |
| **Scope**    | 🟡 At risk   | ↓     | [What's causing concern]  |
| **Budget**   | 🟢 On track  | →     | [Brief context]           |
| **Quality**  | 🟢 Good      | ↑     | [What's improving]        |
| **Team**     | 🟡 Stretched | →     | [Staffing or morale note] |

**Status key:** 🟢 On track · 🟡 At risk · 🔴 Off track / blocked
**Trend key:** ↑ Improving · → Stable · ↓ Declining

---

## ⚠️ Decisions Needed

> **This section is for items that require action from leadership or stakeholders.** If nothing needs a decision, write "No decisions needed this period."

### Decision 1: [Specific question that needs an answer]

**Context:** [Why this decision is needed now — 2–3 sentences]

**Options:**

| Option     | Impact         | Recommendation                  |
| ---------- | -------------- | ------------------------------- |
| [Option A] | [What happens] | [Recommended / Not recommended] |
| [Option B] | [What happens] | [Recommended / Not recommended] |

**Deadline:** [When this decision is needed by and what happens if it's delayed]

### Decision 2: [Another question]

[Same structure as above]

---

## 📊 Key Metrics

| Metric                             | Previous | Current | Target   | Trend   |
| ---------------------------------- | -------- | ------- | -------- | ------- |
| [Metric 1 — e.g., Sprint velocity] | [Value]  | [Value] | [Target] | [↑/→/↓] |
| [Metric 2 — e.g., Open bugs]       | [Value]  | [Value] | [Target] | [↑/→/↓] |
| [Metric 3 — e.g., Test coverage]   | [Value]  | [Value] | [Target] | [↑/→/↓] |
| [Metric 4 — e.g., Uptime SLA]      | [Value]  | [Value] | [Target] | [↑/→/↓] |

<details>
<summary><strong>📊 Detailed Metrics</strong></summary>

[Extended metrics, charts, or breakdowns that support the summary table but would overwhelm the main report.]

</details>

---

## ✅ Accomplishments

### Completed this period

- **[Accomplishment 1]** — [Impact or outcome. Why it matters.]
- **[Accomplishment 2]** — [Impact]
- **[Accomplishment 3]** — [Impact]

### Milestones

| Milestone     | Planned date | Actual date | Status         |
| ------------- | ------------ | ----------- | -------------- |
| [Milestone 1] | [Date]       | [Date or —] | ✅ Complete    |
| [Milestone 2] | [Date]       | [Date or —] | 🔄 In progress |
| [Milestone 3] | [Date]       | —           | 📋 Upcoming    |

---

## 🔄 In Progress

| Work item | Owner    | Started | Expected completion | Status                         |
| --------- | -------- | ------- | ------------------- | ------------------------------ |
| [Item 1]  | [Person] | [Date]  | [Date]              | [On track / At risk / Blocked] |
| [Item 2]  | [Person] | [Date]  | [Date]              | [Status]                       |
| [Item 3]  | [Person] | [Date]  | [Date]              | [Status]                       |

---

## 🚨 Risks and Issues

### Active risks

| Risk     | Likelihood | Impact  | Mitigation                  | Owner    |
| -------- | ---------- | ------- | --------------------------- | -------- |
| [Risk 1] | 🟡 Medium  | 🔴 High | [What we're doing about it] | [Person] |
| [Risk 2] | [Level]    | [Level] | [Mitigation]                | [Person] |

### Active blockers

| Blocker                 | Impact           | Needed from       | Status                           |
| ----------------------- | ---------------- | ----------------- | -------------------------------- |
| [Blocker 1 — or "None"] | [What's delayed] | [Who can unblock] | [Escalated / Waiting / Resolved] |

<details>
<summary><strong>📋 Resolved Issues</strong></summary>

| Issue     | Resolution            | Date resolved |
| --------- | --------------------- | ------------- |
| [Issue 1] | [How it was resolved] | [Date]        |
| [Issue 2] | [Resolution]          | [Date]        |

</details>

---

## 📍 Plan for Next Period

### Priorities

1. **[Priority 1]** — [What will be done and expected outcome]
2. **[Priority 2]** — [What will be done]
3. **[Priority 3]** — [What will be done]

### Key dates

| Date   | Event              |
| ------ | ------------------ |
| [Date] | [What's happening] |
| [Date] | [What's happening] |

---

## 🔗 References

- [Project board / Jira / Linear](https://example.com) — Live work tracking
- [Previous status report](../../docs/project/kanban/sprint-2026-w07-agentic-template-modernization.md) — For context on trends
- [Relevant decision record](../adr/ADR-001-agent-optimized-documentation-system.md) — Background on recent changes

---

_Next report due: [Date]_
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall