[Markdown] Tools for working with agents.
docs Move the standard out of references/
Keep the ASD-STE100 PDF and its .gitignore directly in steering/ste100/ and remove the references/ directory and its README.org note. Change the PDF path in ste100.md to the new location. Align the Common Fixes table so that each column has the same width.
Changed files
steering/ste100/.gitignore
@@ -0,0 +1,3 @@
1
Added:
# Copyrighted reference material — supply locally, never commit.
2
Added:
# ASD-STE100 is a paid standard. Place your own copy in this directory.
3
Added:
ASD-STE100_ISSUE9.pdf
steering/ste100/references/.gitignore
@@ -1,3 +0,0 @@
1
Removed:
# Copyrighted reference material — supply locally, never commit.
2
Removed:
# ASD-STE100 is a paid standard. Place your own copy in this directory.
3
Removed:
ASD-STE100_ISSUE9.pdf
steering/ste100/references/README.org
@@ -1,16 +0,0 @@
1
Removed:
#+TITLE: STE100 reference material
2
Removed:
3
Removed:
This directory holds the ASD-STE100 standard, which =ste100.md= cites for
4
Removed:
deep lookups. The standard is a paid, copyrighted document, so the repo
5
Removed:
does not commit it. The =.gitignore= in this directory keeps it out.
6
Removed:
7
Removed:
Place your own copy here, with this exact name:
8
Removed:
9
Removed:
#+begin_example
10
Removed:
ASD-STE100_ISSUE9.pdf
11
Removed:
#+end_example
12
Removed:
13
Removed:
The steering rules in =ste100.md= work without the PDF.
14
Removed:
15
Removed:
This file is Org, not Markdown, on purpose. Kiro loads every =*.md= file
16
Removed:
under =~/.kiro/steering/= as a steering rule, and this note is not one.
steering/ste100/ste100.md
@@ -6,7 +6,7 @@
6
6
7
7
Write clear, plain prose. These rules distill the high-value 20 percent of
8
8
ASD-STE100 Issue 9 that prevents most writing problems. The full standard and
9
Removed:
dictionary are at `~/.kiro/steering/ste100/references/ASD-STE100_ISSUE9.pdf`.
9
Added:
dictionary are at `~/.kiro/steering/ste100/ASD-STE100_ISSUE9.pdf`.
10
10
11
11
## Scope
12
12
@@ -45,20 +45,20 @@
45
45
46
46
## Common Fixes
47
47
48
Removed:
| Instead of | Write |
49
Removed:
|-----------------------------|-----------------------------------------|
50
Removed:
| "In order to" | "To" |
51
Removed:
| "It is necessary to" | "You must" |
52
Removed:
| "Carry out the deployment" | "Deploy" or "Run the deployment" |
53
Removed:
| "Don't" / "can't" / "won't" | "Do not" / "cannot" / "will not" |
54
Removed:
| "Utilize" | "Use" |
48
Added:
| Instead of | Write |
49
Added:
|-----------------------------|---------------------------------------------|
50
Added:
| "In order to" | "To" |
51
Added:
| "It is necessary to" | "You must" |
52
Added:
| "Carry out the deployment" | "Deploy" or "Run the deployment" |
53
Added:
| "Don't" / "can't" / "won't" | "Do not" / "cannot" / "will not" |
54
Added:
| "Utilize" | "Use" |
55
55
| "Execute" | "Do" (the STE dictionary rejects "execute") |
56
Removed:
| "Prior to" | "Before" |
57
Removed:
| "Subsequent to" | "After" |
58
Removed:
| "Terminate" | "Stop" |
59
Removed:
| "Initiate" | "Start" |
60
Removed:
| "i.e." / "e.g." / "etc." | "that is" / "for example" / list items |
61
Removed:
| Semicolons | Period, then a new sentence |
56
Added:
| "Prior to" | "Before" |
57
Added:
| "Subsequent to" | "After" |
58
Added:
| "Terminate" | "Stop" |
59
Added:
| "Initiate" | "Start" |
60
Added:
| "i.e." / "e.g." / "etc." | "that is" / "for example" / list items |
61
Added:
| Semicolons | Period, then a new sentence |
62
62
63
63
For the complete rule set (part-of-speech constraints, multi-word noun methods,
64
64
safety-instruction format, word-counting rules, and the approved dictionary),