Overview

This document defines how the Logos Blockchain team creates, reviews, approves, and maintains technical documentation across its lifecycle.

It covers:

• The purpose and required contents of Requests for Comments (RFCs) and Specifications.
• The maturity stages a document can move through (Raw → Draft → Verified → Merged → Stable → Deprecated → Retired → Deleted).
• The approval and disapproval criteria at each stage, including required reviewers.
• Versioning rules and responsibilities for updating dependent documents via specification backlinks.

<aside> 💡

We introduced this process to make it easier to track changes and maintain an up-to-date set of specifications. Some specifications were written before introducing this process, so they do not follow these requirements and have been transitioned manually.

</aside>

Documentation Maintaining Process

The basic type of a document that we maintain is Specification. It contains a clear description and must follow the IMPORTANT: Specs Quality Standard. We also maintain supplementary documents such as Analysis, Overview or Template, which are part of our documentation but are not Specifications.

Our documentation is maintained through a Requests for Comments (RFCs) process, which is laid out in this document. This process uses RFC documents to motivate, introduce, analyze, and approve changes to an existing specification, or to propose a new specification.

An RFC must include:

• A reference to the specification it modifies.
• The goal of the modification, why the specification must change, and the implications of that change.
• A description of the proposed changes.
• An analysis of the implications of implementing those changes.
• Recommended default values, with justification.
• Either:
  • Updated specifications (with changes highlighted, or a full copy of the modified specification), or
  • A new specification that complies with our specification quality standard.

Template

The following template includes a complete step-by-step list (status tracker) that guides you through the process defined below. A successful RFC must follow it.