Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

60%
+1 −0
Q&A Is it overkill to follow style-guides for technical writing?

No, it is not overkill to follow a stylebook. As others have said, you consult it as questions arise and learn as you go; you normally don't read it cover to cover. We all put sticky notes on the o...

posted 12y ago by JLG‭  ·  last activity 4y ago by System‭

Answer
#3: Attribution notice added by user avatar System‭ · 2019-12-08T02:16:51Z (over 4 years ago)
Source: https://writers.stackexchange.com/a/5360
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar JLG‭ · 2019-12-08T02:16:51Z (over 4 years ago)
No, it is not overkill to follow a stylebook. As others have said, you consult it as questions arise and learn as you go; you normally don't read it cover to cover. We all put sticky notes on the oft-consulted sections. Since you went to the trouble of asking your question, you are obviously bothered by the lack of consistency within your company.

Also, since you write a lot for your job, chances are you ARE already following a style. I would suggest you begin compiling a document including all of the things you are constantly looking up and create your own style guide. Who knows, maybe your company will one day adopt your guide! (One suggestion: as you compile your own guide make a note of which authoritative source you base each "rule" on so that you can refer back to it if necessary.)

My company follows _The Associated Press Stylebook_, except when they don't. We have a Word document with the exceptions, which is updated as decisions are made. (It is always noted in the file the date when a rule is changed.) Also, AP changes their style on occasion, and my company has to decide if they agree. As an example, last year AP changed _e-mail_ to _email._ My company did not.

#1: Imported from external source by user avatar System‭ · 2012-04-03T12:33:18Z (about 12 years ago)
Original score: 12