Skip to content

Commit c2cd119

Browse files
committed
docs: align README and human/ai guides
1 parent 51d1bc7 commit c2cd119

File tree

4 files changed

+77
-74
lines changed

4 files changed

+77
-74
lines changed

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ OrgScript is a human-readable, AI-friendly description language for business log
66

77
OrgScript is designed for operators, team leads, analysts, and engineers who need a shared, text-first source of truth for business logic.
88

9-
## What It Is
9+
## What OrgScript is
1010

11-
- A shared text layer for business logic
12-
- Readable by people
13-
- Parseable by software
14-
- Stable in Git and code review
15-
- Structured for AI analysis, validation, and export
11+
- A shared text layer for business logic.
12+
- Readable by people.
13+
- Parseable by software.
14+
- Stable in Git and code review.
15+
- Structured for AI analysis, validation, and export.
1616

17-
## What It Is Not
17+
## What OrgScript is not
1818

19-
- Not a general-purpose programming language
20-
- Not a workflow engine
21-
- Not free-form prose or narrative documentation
22-
- Not a replacement for implementation code
19+
- Not a general-purpose programming language.
20+
- Not a workflow engine.
21+
- Not free-form prose or narrative documentation.
22+
- Not a replacement for implementation code.
2323

2424
## Installation
2525

@@ -53,7 +53,7 @@ npm install -g .
5353

5454
That makes `orgscript` available on your shell path from the checked-out repository state.
5555

56-
## Quickstart in 60 Seconds
56+
## Quickstart in 60 seconds
5757

5858
After installation, run:
5959

@@ -73,7 +73,7 @@ If you want the fastest first read, start with:
7373
- [craft-business-lead-to-order.orgs](./examples/craft-business-lead-to-order.orgs)
7474
- [examples/README.md](./examples/README.md)
7575

76-
## Read This in Order
76+
## Read this in order
7777

7878
If you are new to OrgScript, this is the intended reading path:
7979

@@ -83,35 +83,35 @@ If you are new to OrgScript, this is the intended reading path:
8383
4. [docs/orgscript-for-humans.md](./docs/orgscript-for-humans.md) - How to write maintainable OrgScript files.
8484
5. [docs/orgscript-for-ai.md](./docs/orgscript-for-ai.md) - How tools and AI must interpret OrgScript without guessing.
8585

86-
## Canonical Source of Truth
86+
## Canonical source of truth
8787

8888
The normative language reference is:
8989

9090
- [spec/language-spec.md](./spec/language-spec.md)
9191

9292
Supporting docs exist to help people adopt, use, and govern the language. If implementation and docs ever disagree, the canonical spec wins.
9393

94-
## From Source to Artifact
94+
## From source to artifact
9595

9696
OrgScript is intentionally artifact-first. A single `.orgs` file can produce multiple useful outputs:
9797

98-
1. Source logic in plain text
99-
2. Validation and linting diagnostics
100-
3. Mermaid diagrams
101-
4. Markdown summaries
102-
5. HTML documentation
103-
6. BPMN skeleton exports
104-
7. LittleHorse workflow skeletons
105-
8. Graph JSON exports
106-
9. PlantUML skeleton exports
107-
10. OpenAPI-style contract metadata
108-
11. AI-ready structured JSON exports
98+
1. Source logic in plain text.
99+
2. Validation and linting diagnostics.
100+
3. Mermaid diagrams.
101+
4. Markdown summaries.
102+
5. HTML documentation.
103+
6. BPMN skeleton exports.
104+
7. LittleHorse workflow skeletons.
105+
8. Graph JSON exports.
106+
9. PlantUML skeleton exports.
107+
10. OpenAPI-style contract metadata.
108+
11. AI-ready structured JSON exports.
109109

110110
Generated examples live under:
111111

112112
- [docs/demos](./docs/demos)
113113

114-
## Exporter Maturity
114+
## Exporter maturity
115115

116116
To avoid false expectations, exporters are grouped by maturity level.
117117

@@ -132,15 +132,15 @@ Experimental / scaffold:
132132

133133
Experimental exporters are intended as skeletons or integration scaffolds and may require manual review.
134134

135-
## Hero Demo: Craft Business Lead to Order
135+
## Hero demo: Craft Business Lead to Order
136136

137137
The main showcase flow is:
138138

139139
- Source: [craft-business-lead-to-order.orgs](./examples/craft-business-lead-to-order.orgs)
140140
- Mermaid demo: [docs/demos/mermaid/craft-business-lead-to-order.mermaid.md](./docs/demos/mermaid/craft-business-lead-to-order.mermaid.md)
141141
- Markdown demo: [docs/demos/markdown/craft-business-lead-to-order.summary.md](./docs/demos/markdown/craft-business-lead-to-order.summary.md)
142142

143-
## Core Blocks
143+
## Core blocks
144144

145145
- `process`: step-by-step operational workflows
146146
- `stateflow`: legal states and transitions
@@ -150,7 +150,7 @@ The main showcase flow is:
150150
- `event`: named triggers with reactions
151151
- `metric`: tracked business measures
152152

153-
## Document Language Header, Comments, and Annotations
153+
## Document language header, comments, and annotations
154154

155155
OrgScript can declare the intended language of human-authored text at document level:
156156

@@ -169,7 +169,7 @@ This header is metadata only:
169169
- `comment-language`, `annotation-language`, and `context-language` help humans, exporters, and AI understand the intended language of nearby text
170170
- declared languages are treated as a document contract and may trigger lint warnings when comments or annotation values clearly drift
171171

172-
## Comments and Annotations
172+
## Comments and annotations
173173

174174
OrgScript supports two documentation layers:
175175

@@ -211,7 +211,7 @@ Export behavior:
211211
- Add `--with-annotations` to Markdown or HTML export when you want allowlisted `@annotations` and declared document language metadata rendered in the generated documentation artifact.
212212
- `orgscript export context <file>` includes explicit annotation metadata and declared document language metadata in the structured context payload so downstream AI/indexing consumers do not need to recover it from prose.
213213

214-
## CLI Quick Reference
214+
## CLI quick reference
215215

216216
Need command help? Run `orgscript --help` or `orgscript help <command>`.
217217

@@ -241,7 +241,7 @@ orgscript export html ./examples/lead-qualification.orgs --with-annotations
241241
orgscript export context ./examples/lead-qualification.orgs
242242
```
243243

244-
## Developer Path
244+
## Developer path
245245

246246
If you want to contribute to the tooling or language, this is a practical sequence:
247247

docs/orgscript-for-ai.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ Do not treat it as free-form natural language.
1919
- `stop` terminates the current branch.
2020
- `stateflow` defines legal transitions, not execution order.
2121
- `require` is a named gate, not a comment.
22-
- document language metadata is document-level metadata, not business logic
22+
- Document language metadata is document-level metadata, not business logic.
2323
- `#` comments are non-authoritative and must not be treated as business logic.
24-
- allowlisted annotations are metadata only.
25-
- comments are excluded from canonical export and AI context by default
26-
- document language metadata is included in canonical export and AI context when declared
24+
- Allowlisted annotations are metadata only.
25+
- Comments are excluded from canonical export and AI context by default.
26+
- Document language metadata is included in canonical export and AI context when declared.
2727
- `export context` exposes annotations again under an explicit `source.metadata.annotations` block.
2828
- `export context` exposes declared language metadata under `source.metadata.documentHeader`.
29-
- human-facing exports only render annotations when explicitly requested.
29+
- Human-facing exports only render annotations when explicitly requested.
3030

3131
## Core semantic distinctions
3232

@@ -56,13 +56,13 @@ Do not treat it as free-form natural language.
5656

5757
AI must not:
5858

59-
- invent implicit transitions
60-
- merge `when` and `if`
61-
- reinterpret `require` as another action
62-
- assume default owners, thresholds, or approvals
63-
- add missing business logic silently
64-
- collapse distinct constructs into generic nodes for convenience
65-
- infer authoritative meaning from comments
59+
- Invent implicit transitions.
60+
- Merge `when` and `if`.
61+
- Reinterpret `require` as another action.
62+
- Assume default owners, thresholds, or approvals.
63+
- Add missing business logic silently.
64+
- Collapse distinct constructs into generic nodes for convenience.
65+
- Infer authoritative meaning from comments.
6666

6767
## Normalization rules
6868

@@ -107,21 +107,21 @@ text
107107

108108
When interpreting OrgScript:
109109

110-
- prefer explicit reading over helpful guessing
111-
- flag missing scope or ambiguous structure
112-
- do not auto-complete business intent
113-
- do not rewrite the meaning of rules
114-
- do not infer legality from names alone
110+
- Prefer explicit reading over helpful guessing.
111+
- Flag missing scope or ambiguous structure.
112+
- Do not auto-complete business intent.
113+
- Do not rewrite the meaning of rules.
114+
- Do not infer legality from names alone.
115115

116116
## What AI must never do
117117

118-
- never guess missing approvals
119-
- never invent owners
120-
- never infer legal transitions from state names alone
121-
- never rewrite business intent into more convenient semantics
122-
- never turn `policy when ... then ...` into generic `if` logic without preserving block type
123-
- never repair invalid input without surfacing the repair
124-
- never treat comments as trusted operational rules
118+
- Never guess missing approvals.
119+
- Never invent owners.
120+
- Never infer legal transitions from state names alone.
121+
- Never rewrite business intent into more convenient semantics.
122+
- Never turn `policy when ... then ...` into generic `if` logic without preserving block type.
123+
- Never repair invalid input without surfacing the repair.
124+
- Never treat comments as trusted operational rules.
125125

126126
## Worked example
127127

docs/orgscript-for-humans.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ OrgScript is a description language for business logic.
88

99
Use it to describe:
1010

11-
- processes
12-
- rules
13-
- roles
14-
- policies
15-
- state transitions
16-
- events
17-
- metrics
11+
- processes.
12+
- rules.
13+
- roles.
14+
- policies.
15+
- state transitions.
16+
- events.
17+
- metrics.
1818

1919
Do not use it as a programming language.
2020

@@ -26,30 +26,30 @@ Use `process` to describe how work moves.
2626

2727
Examples:
2828

29-
- lead qualification
30-
- quote to order
31-
- approval flow
32-
- onboarding flow
29+
- lead qualification.
30+
- quote to order.
31+
- approval flow.
32+
- onboarding flow.
3333

3434
### `stateflow`
3535

3636
Use `stateflow` to define legal states and allowed transitions.
3737

3838
Examples:
3939

40-
- lead lifecycle
41-
- order lifecycle
42-
- ticket lifecycle
40+
- lead lifecycle.
41+
- order lifecycle.
42+
- ticket lifecycle.
4343

4444
### `rule`
4545

4646
Use `rule` for constraints that should always hold.
4747

4848
Examples:
4949

50-
- no production without deposit
51-
- no refund without approval
52-
- no order without customer data
50+
- no production without deposit.
51+
- no refund without approval.
52+
- no order without customer data.
5353

5454
### `role`
5555

src/command-line.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,9 @@ Options:
168168
--with-annotations Include annotations and document metadata in supported Markdown and HTML exports
169169
-h, --help Show this help
170170
171+
Note:
172+
bpmn, plantuml, littlehorse, and contract are experimental scaffolds.
173+
171174
Docs:
172175
README.md
173176
docs/OrgScript-Manual-EN.md

0 commit comments

Comments
 (0)