Company
Apify writing style guide
90 rules across 6 topics, naming 1,114 terms.
- 4 errors
- 19 warnings
- 67 suggestions
- Rules from
- apify/vale-rules
- Read at
- 1cae9f7
- License
- Apache-2.0
- Used by
- 1 of 355 public configs
The guide, by topic
Select a rule to see what it asks for.
Word choice
75 rules · preferred terms, jargon, and words to avoidAcademic register 5 Actor capitalization Actor name article All caps Alt text filename Apify brand casing Apify product names 14 Article sound 56 Brand voice 33 Brands 81 Bureaucratic voice 49 Click here Code fence language Color only meaning 24 Consistent terminology 2 Creation redundant new 2 Currently removal 22 Customer user ambiguity 6 Dangling participle 2 Device agnostic verbs 8 Domain verbs 12 Double hedge 12 Double you can Filler words 197 Generic technical terms Gerund subjects 31 Grammar 41 Ie eg confusion 2 Image alt text Including expansion Inclusive language 41 Just removal 2 Loose sentence Mixed register 2 Near repetition 9 Non localizable idioms 31 Numbers 4 Orphaned conditional 3 Over bolding Overstatement 4 Parallel list form Plain language 128 Please removal 64 Positive form 29 Product articles 2 Punctuation 55 Repetition Selection clarity 8 Self congratulatory 4 Sentence starts 35 Session term inconsistency 10 Significance inflation 17 Spatial references 25 Spell out and 2 Spelling 69 Subjectless consequence 3 Such as etc Technology names 12 Tooltip info hiding 9 Typos 33 Unverifiable time promise 17 Vague quantifiers Weak qualifiers 47 Weak verbs 54 Admonition title Alt text all caps Alt text diagram intro Alt text missing period Alt text photographer credit Alt text redundant prefix Alt text too long Alt text too short H1 Retention without action 2 Sales language 10
Concision
1 rule · long sentences, filler, and wordy phrasesReadability
Voice and tone
2 rules · person, tense, contractions, and claimsContractions 74 Passive to active 116
Punctuation
4 rules · commas, dashes, quotes, and spacingCorrupted em dash Dash as aside 2 Em dash avoidance 15 No comma after eg
Headings
3 rules · capitalization and punctuation in titlesHeading article 9 Heading depth Gerund heading 4
Abbreviations
5 rules · acronyms, latin, and periodsAcronym case 9 Latin abbreviations 2 Latin paren strip 2 Latin sentence start 4 Version abbreviation 2
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| 1 additional | 1 more | |
| 1 extra | 1 more | |
| 1-on-1 | 1on1 | |
| 1t1 | 1on1 | |
| a Actor | an Actor | |
| a API | an API | |
| a API- | an API- | |
| a Apify | an Apify | |
| a bit complex | complex | |
| a bit confusing | confusing | |
| a bit different | different | |
| a bit fast | fast | |
| a bit less | less | |
| a bit misleading | misleading | |
| a bit more | more | |
| a bit slow | slow | |
| a bit tricky | tricky | |
| a ETL | an ETL | |
| a FAQ | an FAQ | |
| a FSA | an FSA | |
| a heir | an heir | |
| a herb | an herb | |
| a honest | an honest | |
| a honor | an honor | |
| a hour | an hour | |
| a HTML | an HTML | |
| a HTTP | an HTTP | |
| a ICU | an ICU | |
| a ID | an ID | |
| a large number of | many | |
| a MCP | an MCP | |
| a moment | a few seconds | |
| a MVP | an MVP | |
| a NLP | an NLP | |
| a npm | an npm | |
| a OAuth | an OAuth | |
| a OOM | an OOM | |
| A piece of cake | straightforward | |
| a reminder of | Avoid it | |
| a RSS | an RSS | |
| a SDK | an SDK | |
| a SPA | an SPA | |
| a SSH | an SSH | |
| a SSL | an SSL | |
| a XML | an XML | |
| absolutely free | free | |
| accommodate your needs | work for you | |
| accordingly | Avoid it | |
| act accordingly | Avoid it | |
| actor.json file | actor.json | |
| Add a new | Avoid it | |
| Additional | More | |
| additionally | Avoid it | |
| addon | add-on | |
| addons | add-ons | |
| aforementioned | these | |
| AI Agents | AI agents | |
| AI tools | tools for AI | |
| AI-first platform | platform built for AI | |
| AI-native platform | platform built for AI |
These rules run in Vale, which checks a whole documentation set against a guide in your editor and on every pull request.
All 16 guides