Document Version and Maintenance Notes
| Item | Content |
|---|---|
| Document number | 99 |
| Module | Appendices and Reference Materials |
| Core keywords | version management, maintenance notes, document standards, changelog, setting maintenance |
I. Overview of the Document System
The setting system of the Anchor Symbiotic Civilization consists of 100 Markdown documents, numbered from 00 to 99, divided into ten major modules, with 10 documents in each module. The document system takes SPEC.md (Document Generation Specification) as its hard constraint, takes "00-Heng Yuan Zhou: Cosmic Overview" as the general outline, develops each module's documents in detail from different dimensions, and finally uses the appendix documents 90–99 for indexing, summarization, and consolidation. The entire document system constitutes a complete setting knowledge base that is logically self-consistent, clearly layered, and mutually cross-referenced.
The design of the document system follows three major principles: "modularity, structure, and extensibility." Modularity means that each document focuses on one specific topic and stands as an independent article; structure means that all documents follow a unified format specification for ease of reading and retrieval; extensibility means that the document system reserves ample room for expansion, allowing the continuous improvement of the settings through revising existing documents and adding new content.
II. Version Numbering Rules
The document system adopts a three-level version numbering rule of "major version.minor version.revision number":
| Version level | Numbering rule | Trigger condition | Example |
|---|---|---|---|
| Major version | Increments from 1 | Major architectural adjustments to the document system, such as module redivision or changes to core settings | v1.0 → v2.0 |
| Minor version | Increments from 0 | Substantive revision of the core content of a document, or the addition of important new setting content | v1.0 → v1.1 |
| Revision number | Increments from 0 | Non-substantive modifications such as textual corrections, format adjustments, and terminology unification | v1.0 → v1.0.1 |
The current overall version of the document system is v1.0, i.e., the first complete release. Each document records its own version number in its document information block, and the overall version number of the document system is uniformly recorded in this document.
III. Review of Document Format Specifications
All documents must follow the following unified format specifications (see SPEC.md for detailed specifications):
3.1 File Naming
The file name format is XX-Document Title.md, where XX is a two-digit number from 00 to 99, and the title is in Chinese without spaces.
3.2 Document Structure
Each document must contain the following structural elements:
- Level-one heading: the document title (consistent with the file name)
- Document information block: a table of number, module, and core keywords (3–5)
- Main body: at least 3 sections with level-two headings, using structured elements such as lists and tables
- Conclusion: a brief summary paragraph
- Related documents: listing 2–3 related document numbers and names
3.3 Word Count Requirement
The main body of each document shall be no less than 800 characters (excluding headings and meta-information).
3.4 Writing Style
- A serious, systematic setting-document style, similar to an encyclopedia/setting collection
- Use unified terms such as "Hengyuan Universe," "Anchor," and "Symbiosis"
- Newly added settings must be logically self-consistent with existing settings and conform to the principle of "Reality as the Foundation, upgrading through laws"
IV. Maintenance Organization and Responsibilities
4.1 Setting Maintenance Committee
The Setting Maintenance Committee is the highest maintenance body of the document system, composed of senior setting creators, logic verification experts, and user representatives. Its core responsibilities include:
- Reviewing the overall architecture of the document system and major revision plans
- Reviewing major setting changes to ensure consistency with core settings
- Arbitrating setting disputes and providing authoritative interpretations
- Regularly organizing comprehensive setting consistency self-checks
- Publishing overall version updates of the document system
4.2 Module Maintainers
Each module designates one module maintainer, responsible for the daily maintenance of the 10 documents in that module. Their responsibilities include:
- Tracking the setting consistency of the documents within the module
- Reviewing revision applications for documents within the module
- Coordinating cross-references among documents within the module
- Collecting user feedback and suggestions on the module's content
- Regularly reporting the module's maintenance status to the Setting Maintenance Committee
4.3 Document Creators
Any qualified creator may participate in the creation and revision of documents. The responsibilities of creators include:
- Creating or revising documents in accordance with the format specifications
- Ensuring that created content passes the check of the Setting Contradiction Self-Check List
- Attaching a detailed revision description when submitting revisions
- Cooperating with the review work of maintainers and the Committee
V. Revision Process
5.1 Regular Revision Process
- Submit an application: the creator submits a revision application to the module maintainer, including the document number to be revised, a description of the revision content, and the reasons for the revision.
- Module review: the module maintainer reviews the revision content, focusing on format specifications and intra-module consistency. After approval, it is submitted to the Setting Maintenance Committee.
- Committee approval: the Setting Maintenance Committee conducts the final review of the revision content, focusing on cross-module consistency and core-setting consistency.
- Execute the revision: after approval, the module maintainer or the original author executes the document revision.
- Version update: after the revision is completed, update the document version number and record it in the changelog of this document.
- Related-document synchronization: if the revision content affects other documents, the related documents must be revised in synchronization.
5.2 Emergency Revision Process
For emergency situations where serious setting contradictions or errors are discovered, the emergency revision process may be initiated:
- Emergency report: the discoverer immediately reports the problem to the Setting Maintenance Committee.
- Rapid review: the Committee completes the emergency review within 24 hours and provides a revision plan.
- Execute the revision: designate a dedicated person to execute the revision immediately.
- Retroactive documentation: after the revision is completed, retroactively record the revision application and review records.
5.3 Regular Comprehensive Revision
The Setting Maintenance Committee organizes a comprehensive revision of the document system once a year, including:
- A comprehensive setting consistency self-check
- Centralized handling of user feedback
- Unification and updating of the terminology system
- Synchronized updating of index documents
- Unified checking and correction of document formats
VI. Changelog
v1.0 (First Complete Release)
- Completed the creation and release of all 100 documents
- Established the complete document system architecture and format specifications
- Completed content coverage of the ten major modules
- Established the appendix index system (terminology dictionary, system index, law index, chronology, register of the Ten Thousand Races, figures and organizations, FAQ, self-check list, expansion suggestions, version notes)
Area for Recording Subsequent Version Updates
(Update content of subsequent versions will be appended and recorded here, including version number, release date, and summary of main update content)
VII. Document Citation and Cross-Reference Specifications
7.1 Internal Citations
Cross-references among documents use the format of "document number-document title," for example, "see Document 84 'General Framework of Archaeological Protocols'." When citing, it should be ensured that the cited document indeed exists and that the number and title are correct.
7.2 Terminology Citations
When a core term is first used, the corresponding entry in Document 90 "The Glossary" may be noted for reference. When the same term is used subsequently, no repeated notation is needed.
7.3 External Citations
If real-world materials or fictional works outside the setting system need to be cited, the source should be noted, and it should be clearly stated that such citation is reference material under the principle of "Reality as the Foundation," and does not represent the complete adoption of its content by the setting system.
VIII. Quality Assurance Mechanisms
8.1 Setting Contradiction Self-Check
All newly created and revised documents must pass all check items of Document 97 "Setting Contradiction Self-Check List," including more than 40 checks in three major categories: core-setting consistency, cross-module logical consistency, and document format specifications.
8.2 Cross-Review
Each document must undergo cross-review by at least one other creator before formal release, focusing on cross-module logical consistency and terminology uniformity.
8.3 User Feedback Mechanism
The document system provides user feedback channels; users may submit feedback through the following ways:
- Reporting setting contradictions and logical errors
- Raising issues of terminology inconsistency
- Suggesting supplements or revisions to specific content
- Pointing out format and textual errors
All feedback is processed in categories by the module maintainers, and important feedback is submitted to the Setting Maintenance Committee for deliberation.
8.4 Quarterly Consistency Report
The Setting Maintenance Committee publishes a "Setting Consistency Report" every quarter, including:
- Setting contradictions discovered in the quarter and their handling
- Statistics of document revisions in the quarter
- Progress of terminology unification
- Handling of user feedback
- Maintenance plan for the next quarter
IX. Document Storage and Distribution
9.1 Storage Format
All documents are stored in Markdown (.md) format, ensuring cross-platform readability and convenient version management. Documents use UTF-8 encoding, supporting Chinese and special characters.
9.2 Directory Structure
Documents are uniformly stored in the anchor-docs/ directory, with file names in the format of XX-Document Title.md. SPEC.md, as the specification file, is also stored in the same directory.
9.3 Version Management
It is recommended to use version control systems such as Git for document version management, attaching detailed commit messages recording the revision content and reasons for each revision submission.
9.4 Distribution Methods
The document system may be distributed in the following ways:
- Packaged as a ZIP archive for download
- Deployed as a static website for online browsing
- Converted to PDF or EPUB format for reading
- Imported into knowledge base systems for structured management
Conclusion
The Document Version and Maintenance Notes are the "administrative constitution" of the setting system of the Anchor Symbiotic Civilization. It establishes the version rules, maintenance organization, revision process, quality assurance mechanisms, and storage and distribution methods of the document system, ensuring that this vast setting system composed of 100 documents can always maintain order and consistency in the course of continuous growth. A good setting system requires not only wonderful content, but also a sound maintenance mechanism to guarantee its long-term healthy development. This document is the core carrier of that mechanism.
Related Documents
- 97-设定矛盾自查表 (Setting Contradiction Self-Check List)
- 90-术语词典 (The Glossary)
- 00-衡元宙宇宙总览 (Heng Yuan Zhou: Cosmic Overview)