Project: Hypergravity Habitat
Document type: documentation style and review standard
Status: recommended public-repository standard
Scope: Markdown documents, equations, evidence levels, links, claims, footers, and public readability
This guide defines how Hypergravity Habitat documents should be written before and after the repository becomes public.
The project combines physics, engineering, biology, human factors, safety, ethics, and programme planning. The writing must therefore be readable to interdisciplinary reviewers, not only to specialists.
Write for:
Do not assume that all readers know LaTeX, railway engineering, centrifuge terminology, or space-medicine shorthand.
Do not leave reader-facing formulas in unfinished markup form. Avoid display-math delimiters or inline-math delimiters that only work in certain renderers.
Use readable plain text or Unicode notation:
g_eff = √(g² + a_c²)
Then explain it immediately:
The effective gravity is the vector combination of Earth gravity and the generated centripetal acceleration.
After any formula, define every symbol used.
Example:
a_c = v² / r
Where:
a_c is centripetal acceleration,v is tangential speed,r is radius.Use formulas only where they improve understanding. In proposal, governance, ethics, roadmap, and outreach documents, prefer plain language unless a formula is essential.
Every major claim should fall into one of these categories:
| Evidence level | Use when |
|---|---|
| Established knowledge | supported by accepted physics, engineering practice, peer-reviewed literature, or official institutional sources |
| Engineering principle | follows directly from stated equations and assumptions |
| Engineering estimate | approximate and dependent on assumptions |
| Working hypothesis | plausible but not demonstrated for this project |
| Open research question | requires literature review, modelling, experiment, or expert feedback |
| Later-stage possibility | relevant only after prior safety, ethics, and feasibility gates |
Avoid converting hypotheses into claims by tone.
Do not claim that sustained moderate hypergravity:
Use cautious language:
Use citations for:
A citation should support the exact statement being made. Unverified reference metadata should be marked clearly until checked; before outreach to domain experts, verify the most central sources.
Use relative links so the repository works when cloned or browsed locally.
Examples:
[Physics Reference](/Hypergravity-Habitat/docs/physics-reference.html)
[Design Requirements](/Hypergravity-Habitat/docs/engineering/design-requirements.html)
[README](/Hypergravity-Habitat/)
Run a link check before public release.
Each major document should begin with:
# Document Title
**Project:** Hypergravity Habitat
**Document type:** short description
**Status:** working / draft / review-ready / deprecated
**Scope:** what the document covers
Optional fields:
**Audience:** target readers
**Last updated:** YYYY-MM-DD
Each Markdown document should end with a short footer.
For files in docs/:
---
<!-- project-footer -->
**Project:** [Hypergravity Habitat](/Hypergravity-Habitat/) · **Status:** exploratory research documentation · **License:** see repository license and file-level notes
For files in docs/science/, docs/engineering/, or docs/economics/ use ../../README.md as the target. For files in the repository root use README.md.
The footer does not replace the license file.
When contacting potential reviewers or collaborators:
Recommended phrase:
We are not seeking endorsement at this stage. We are seeking critical review of the research gap, assumptions, safety logic, and staged demonstrator pathway.
Before a document is considered public-ready, check:
Project: Hypergravity Habitat · Status: exploratory research documentation · License: see repository license and file-level notes