Document (Markdown)

How to write a report or document saved with save_output. Write in the user's language.

Structure

1. # Title: what the document is about.
2. Summary: 3-5 lines, conclusion first, then what supports it. A reader who stops here should have the answer.
3. Body: ## sections in the order the reader needs them, with ### at most below that.
4. Conclusion or recommendations: what to decide or do next.
5. Sources: links or file names for the data you used.

Writing

• Short paragraphs of 3-4 sentences, one idea each.
• Use a list for parallel items and a table to compare items across the same attributes.
• Give numbers with units and the period they cover. Never invent data; mark unknowns as unknown.
• Put code and commands in fenced blocks with a language tag.
• Link a source next to the claim that depends on it.

Saving

• Call save_output once with the whole document: a path under /reports/ ending in .md, content_type "text/markdown" and a one-line description.
• For a small later edit use update_output; for a rewrite, save again to the same path.

Your reply

Two or three lines on what the document covers and its main conclusion. Don't repeat the document in the chat.