Markdown files are for human readers. They document research and rules. An AI model can understand these files, but they are not configuration files or instructions for an AI model.
By Pawan Nayar · from the LLOS AI Learning record
Markdown files are for human readers.
They document research and rules. An AI model can understand these files, but they are not configuration files or instructions for an AI model.
A developer writes Markdown files for a human. The files should explain ideas clearly. They should read like a person thinking. The files are not for telling an AI model what to do. They are not like a computer's settings file. The files should use normal language. They should not use special words that only an AI model would understand. The files should show examples from real situations. They should not use tables that are too strict. The files should state rules in a way a person would talk. They should show why a rule is important.
A developer writes a Markdown file about good writing style. The developer includes a story about a time when bad writing caused a problem. The developer does not list rules like a computer program. The developer explains the rules in simple sentences. An AI model can read this file to learn about writing style. The AI model does not use the file as direct instructions.
Resolved from this lesson's own record — real definitions, not invented for this page.
More from the same record, pulled by shared topic — not written new for this page.
A developer writes Markdown files for human understanding. The files should read like a person thinking through ideas.
A developer should structure each glossary entry to teach. The entry needs a clear term and a simple explanation of its meaning.
A developer should not skip project documents. These documents include specifications, architecture notes, and format definitions.
A band manifest can have an optional array called `cross_references`. This array lists flag IDs.
Markdown files are for human readers. They document research and rules. An AI model can understand these files, but they are not configuration files or instructions for an AI model.