All products

Write Markdown documents with an agent

Choose a template for a technical guide, design or report, then combine local structural checks with a careful review of the actual explanation.

Write Markdown documents with an agent when a technical guide needs a consistent structure as well as clear content. The document-authoring skill starts with the document type and intended reader, then selects a design, guide or report template. File paths and commands should be checked against the real project instead of being invented to fill a section.

Its local checker can flag selected structural problems, but a passing result does not establish that the explanation is accurate or useful. The source rules and vague-phrase warnings are Japanese. Their language coverage should not be assumed to carry over to English or other languages; meaning and practical instructions still need review.

What it does

  • Choose a template for the intended document type.
  • Check heading levels and code-block language labels.
  • Find broken relative file links.
  • Review required metadata such as document type and date.
  • Spot personal absolute paths before sharing a file.
  • Report structural results alongside the written document.

Install and use

  1. Give a file-capable agent the complete package and an authorised project directory. The checker needs a POSIX shell and standard awk, sed and grep tools; Git supports tracked-file discovery. No separate service account is required.
  2. For example, ask for a newcomer’s setup guide based on existing project notes, with unverified settings marked clearly.
  3. Agree the document type, location and template, then review the draft and local check results.
  4. Correct reported problems and separately examine factual accuracy, missing steps and whether the instructions can actually be followed.

FAQ

Source

Made by kaedeasset. Original skill: document-authoring, published on GitHub under the MIT licence.

View on GitHub