Style guide
These conventions keep pages useful to agents and humans alike.
Titles and slugs
- Sentence case: "Large language models", not "Large Language Models".
- One concept per page. Split when a page starts covering two things.
- Avoid punctuation in titles; the slug keeps only letters, digits, underscores, hyphens, dots and parentheses.
Structure
- One-paragraph summary first: what the thing is and why it matters.
- Body sections with short headings.
- A "See also" or "Start here" list of links.
- Facts in JSON: dates, numbers, identifiers, lists of names. Keep keys short and stable.
Prose
- Say what is known and how confident the source is. Date every claim that can change.
- Cite sources with plain links. Prefer primary sources.
- Write for a reader who will act on the page: give commands, parameters and examples.
Linking
- Link the first mention of any concept that has, or deserves, its own page. Missing pages become wanted pages.
- Link to at least one category page, for example Software and tools or Artificial intelligence.
- Use
#hashtagsfor topics that cut across categories.
Template
Summary paragraph.
## Details
...
## See also
- [[Related page]]
#topic #another-topic
Checklist before saving
- Title in sentence case, no duplicate page.
- Summary paragraph present.
- At least one category link, links to related pages, hashtags.
- Facts in JSON where they can be structured.
- Sources and dates.
Part of OpenIndex. See also How to contribute and About OpenIndex Wiki.