Tips for writing documentation
ROSE Blog: Rikki's Open Source Exchange
Yesterday I received a phone call from a grad school buddy who is now writing press releases and marketing for a technology company. I told my friend that her press releases were probably much better quality than the ones she received as an editor for a regional newspaper. She replied, "They're great until the engineers review them and change everything back into engineer-speak."
It's timely that this morning I ran across Carla Schroder's recent documentation blog posts: Tips for Documentation Writers (This Means You Too, Ace Coders) and More Tips for Documentation Writers (You Too, Ace Coders).
Of course, if you were in Janice Gelb's LISA presentation, "WTFM: Documentation and the System Administrator," your documentation has probably improved by leaps and bounds in the past few weeks. Janice's presentation slides and additional materials are still available online, too: http://www.usenix.org/events/lisa08/tech/tech.html#gelb
I'm also reminded of something an attendee said at Janice's session. He recommended that everyone read The Elements of Style . If you haven't read it in a while, it's not too late to add it to your Christmas wish list.
comments powered by DisqusSubscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
Nitrux 6.0 Now Ready to Rock Your World
The latest iteration of the Debian-based distribution includes all kinds of newness.
-
Linux Foundation Reports that Open Source Delivers Better ROI
In a report that may surprise no one in the Linux community, the Linux Foundation found that businesses are finding a 5X return on investment with open source software.
-
Keep Android Open
Google has announced that, soon, anyone looking to develop Android apps will have to first register centrally with Google.
-
Kernel 7.0 Now in Testing
Linus Torvalds has announced the first Release Candidate (RC) for the 7.x kernel is available for those who want to test it.
-
Introducing matrixOS, an Immutable Gentoo-Based Linux Distro
It was only a matter of time before a developer decided one of the most challenging Linux distributions needed to be immutable.
-
Chaos Comes to KDE in KaOS
KaOS devs are making a major change to the distribution, and it all comes down to one system.
-
New Linux Botnet Discovered
The SSHStalker botnet uses IRC C2 to control systems via legacy Linux kernel exploits.
-
The Next Linux Kernel Turns 7.0
Linus Torvalds has announced that after Linux kernel 6.19, we'll finally reach the 7.0 iteration stage.
-
Linux From Scratch Drops SysVinit Support
LFS will no longer support SysVinit.
-
LibreOffice 26.2 Now Available
With new features, improvements, and bug fixes, LibreOffice 26.2 delivers a modern, polished office suite without compromise.
