Add conciseness rules and product claims guidance to proofread-business-writing skill
This commit is contained in:
parent
b07d413e2e
commit
dfd9af2422
1 changed files with 19 additions and 0 deletions
|
|
@ -45,6 +45,25 @@ Avoid being too prescriptive. We are consultants making recommendations, not dir
|
|||
- **Use commas instead of em dashes.**
|
||||
- Instead of: "The three hikers — exhausted, hungry, and cold — finally reached the summit as the sun began to set."
|
||||
- Say: "The three hikers, exhausted, hungry, and cold, finally reached the summit as the sun began to set."
|
||||
- In list items and colon-introduced clauses, use colons instead of em dashes:
|
||||
- Instead of: "iPad (iOS 14+) — one per check-in lane"
|
||||
- Say: "iPad (iOS 14+): one per check-in lane"
|
||||
- Instead of: "Walk-in attendees can also register on-site — they select the event"
|
||||
- Say: "Walk-in attendees can also register on-site: they select the event"
|
||||
|
||||
### Be concise
|
||||
|
||||
Cut anything that doesn't serve the next question the reader would ask.
|
||||
|
||||
- Remove over-qualifiers and superlatives. Instead of "the single biggest lever for throughput," just say the action and let the reader draw the conclusion.
|
||||
- Remove connectivity or compatibility details unless the reader specifically asked about them (e.g., don't list Wi-Fi/Bluetooth options for a printer unless asked).
|
||||
- Don't list every supported model or option. Name what's relevant and stop.
|
||||
- Use example-agnostic language ("large events") over specific scenarios ("football games or graduations") unless the customer raised a specific use case.
|
||||
- Section transitions should use periods, not colons. Treat section headings as standalone titles.
|
||||
|
||||
### Product claims
|
||||
|
||||
When proofreading product-related content, soften or remove claims that are not documented in official Verkada Help pages. If a claim can't be verified but is likely true from field experience, present it as an observation rather than a product fact.
|
||||
|
||||
### Text formatting
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue