mde-doc

Standardize Markdown documents with MdExplorer conventions and YAML frontmatter.

5|Updated Mar 21, 2021
One-click install
npx skills add https://github.com/salaroglio/MdExplorer --skill mde-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mde-doc
Source: https://github.com/salaroglio/MdExplorer/tree/main/MdExplorer/skills/mde-doc
Command: npx skills add https://github.com/salaroglio/MdExplorer --skill mde-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

MdExplorer documentation convention standardizes how authors create analyses, designs, sprints, how-tos, and narrative Markdown documents within MdExplorer projects, ensuring consistent formatting and a self-contained TL;DR header at the start of each document.

Core Features & Use Cases

  • Enforces a TL;DR header with exactly three bullet points to summarize the document.
  • Defines a three-section document structure (TL;DR, body, quick start) to guide AI agents and readers.
  • Applies to analysis, design, sprint, how-to, and narrative documents (excluding READMEs) to improve consistency and reuse.

Quick Start

Write a new Markdown document following the MdExplorer convention, starting with a self-contained TL;DR header and the required sections.

Frequently Asked Questions about mde-doc

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

FAQPage Schema
How do I standardize Markdown documentation conventions for analyses and design docs?

To standardize Markdown documentation conventions, apply a structured layout with a YAML frontmatter containing name and description, a three-bullet TL;DR header, and a three-section body to ensure consistent formatting across project documents.

What is the required Markdown structure for MdExplorer project documents?

The required Markdown structure for MdExplorer project documents consists of a YAML frontmatter with name and description, a TL;DR header containing exactly three bullet points, and three sections including a Quick Start sentence to guide readers.

Can I use this Markdown standardization convention for README files?

You cannot use this Markdown standardization convention for README files, as it explicitly excludes them and applies only to analyses, designs, sprints, how-tos, and narrative content within MdExplorer projects.

How do I write a TL;DR header for technical documentation?

To write a TL;DR header for technical documentation, summarize the document with exactly three bullet points placed immediately after the YAML frontmatter, ensuring the summary remains self-contained for AI agents and readers.

Does every Markdown document need YAML frontmatter?

Every Markdown document following this convention requires YAML frontmatter with name and description fields to standardize metadata, ensuring consistent authoring and document reuse across MdExplorer projects.

What's the best way to format Markdown documents for consistent reuse across projects?

The best way to format Markdown documents for consistent reuse is to enforce a three-section layout with a self-contained TL;DR, YAML frontmatter, and a Quick Start sentence, standardizing how authors create analyses, designs, and sprints.