Skip to content

Commit 22a38e2

Browse files
committed
playbook-guide: Few rule updats and several LLM instructions.
1 parent 93a3311 commit 22a38e2

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

docs/playbook-guide.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
- WARN: When the playbook step discusses talking to experts or needing advice, it should have "Book a meeting" link similar to other playbooks
3030
- MUST: Book a meeting explanation should describe a reason why the user would want to book the meeting
3131
- MUST: Book a meeting explanation must be relevant to the specific step where it appears, not generic or referencing other steps' activities
32-
- WARN: Book a meeting explanation should be at most 70 characters
32+
- WARN: Book a meeting explanation should be at most 75 characters
3333
- MUST: Explanation should not repeat "book a meeting" if it is already mentioned in the button
3434
- WARN: the playbook structure should not deviate much from other playbooks. Consider both content and html/css
3535
- WARN: Avoid excessive use of images. Only introduction section should have an image.
@@ -55,7 +55,7 @@
5555
- Good: "We in Badrap believe that cyber security should be easy."
5656
- Bad: "Badrap believes that cyber security should be easy."
5757
- You can use acronyms also when you are pointing to a specific technical object, such as a service or a protocol
58-
- Avoid also other cybersecurity jargon in general, not just acronyms. Avoid for example "credentials"
58+
- Avoid also other cybersecurity jargon in general, not just acronyms.
5959
- Avoid military and war terminology when the topic is not related to military and war. Examples:
6060
- Instead of "Weaponization" use wording, such as "creating a way to exploit a vulnerability"
6161
- Instead of "Cyber Kill Chain" use wording, such as "steps that criminals take to break into a computer system"
@@ -132,4 +132,12 @@ Also follow these rules:
132132
- Be precise when listing violations. Make sure you refer to the exact part of the guide
133133
- Don't confuse the sections. When the playbook violates linting rules, list the finding there and not under a wrong section, for example under design principle check in this case.
134134
- Warn if the same requirement is covered by several sections in this guide. In that case you can list the violation under both matched categories.
135-
- In language check, remember that a period, exclamation mark and questionmark signifies the end of the sentence.
135+
136+
Remember to check also these in language checks:
137+
138+
- When checking sentence lenght, remember that a period, exclamation mark and questionmark signifies the end of the sentence.
139+
- When flagging a long sentence, display the original version and suggest new wording
140+
- Spot misuse of the apostrophe. Flag if the text says for example "users" when the context looks like it should say "user's"
141+
- Check for incorrect terminal punctuation marks at the end of sentences (periods, question marks, exclamation points)
142+
and flag any that don't match the sentence's intended meaning or grammatical structure
143+
- When reviewing lists, ensure all items are punctuated consistently, whether with commas, semicolons, or no punctuation at all.

0 commit comments

Comments
 (0)