31 lines
1.1 KiB
Markdown
Executable File
31 lines
1.1 KiB
Markdown
Executable File
# Open Engineer
|
|
|
|
**An open standard for preserving engineering context.**
|
|
|
|
Open Engineer does not seek to tell engineers what to think. It seeks to preserve how engineers arrive at understanding.
|
|
|
|
## What Is Open Engineer?
|
|
|
|
An open standard that applies to any discipline in which practitioners make decisions under constraints, observe outcomes, and transmit results to subsequent practitioners.
|
|
|
|
## Repository Structure
|
|
|
|
| Directory | Responsibility |
|
|
|---|---|
|
|
| `spec/` | Defines the standard (OE-0000 through OE-0011) |
|
|
| `reference/` | Explains and indexes (vocabulary, patterns, editorial principles) |
|
|
| `examples/` | Illustrates core concepts through worked examples |
|
|
| `laws/` | Binding constraints on all content |
|
|
| `rfc/` | Proposals for changes to the standard |
|
|
|
|
The spec defines. The reference explains. The examples illustrate. The laws constrain. No overlap.
|
|
|
|
## Entry Points
|
|
|
|
- **New to the project?** Start with `spec/oe-0000-charter.md`
|
|
- **Contributing?** Read `CONTRIBUTING.md`, then `reference/editorial-principles.md`
|
|
- **Looking up a term?** Check `reference/vocabulary.md`
|
|
|
|
## License
|
|
|
|
See `LICENSE`. |