Chronologue documentation

The main goal of the Chronologue project is to document the API and the website using the templates from the TGD project using a docs-as-code approach. Once the Chronologue group tested the existing templates, we can request additional templates. The request should consist of actionable requirements and a prioritization suggestion. We decided to not actively take part in creating new templates, so we still have a fresh set of eyes when testing a new template.

Documentation tools and setup

We use the Good Docs Project's websiteto host our documentation. The document language is Markdown.

Possible list of docs we want to create for Chronologue

---

🚧 This is a list of docs from a past version of the Wiki. We can revisit it and discuss which doctypes we want to tackle next. 🚧

• Reference
  • api-reference 👍
  • Glossary
  • FAQ
• Manual
  • User guide
  • Installation guide 👍
  • Developers' guide
  • Administrators’ guide
  • Defining personas guide
• Task
  • Tutorial
  • How-to
  • API-quickstart 👍
• Concept
  • Business overview (About page, Landing page)
  • Technical overview
  • Case Study
  • White paper
  • Explanation
• Community
  • Community guidelines
  • README
  • Contributors' guide
  • Code of Conduct
  • Project Governance
  • License
• Style guides
  • Code/Developer style guide
  • Documentation style guide
• Release notes
• Logging
• Pull request template
• Issue reporting template
• Comments (structured comments you can grok and grep)
• Error messages
• Planning
  • Information Architecture
  • Documentation Plan
• Requirements
  • User Stories
  • Engineering Requirements
• Tests

Style

Chronologue is always capitalized.

Preferred Term	Avoid These Terms	Explanation
Chronologue	Chronolog	British English spelling
Chronologue	The Chronologue	Only use the definite article (The) when referring to the project itself.
The Chronologue project...		Only use the definite article (The) when referring to the project itself.
Chronologue helps you...		Chronologue is singular