Call for writers for new column, Doc Dish, on Opensource.com

Dedicated to documentation (a call for proposals)

Typewriter in grass
Image credits : 

Original photo by jetheriot. Modified by Rikki Endsley. CC BY-SA 2.0.

x

Get the newsletter

Join the 85,000 open source advocates who receive our giveaway alerts and article roundups.

Nobody appreciates good documentation. Instead, good documentation is simply there, existing, answering questions, solving problems, and quietly serving its purpose. The bad—or the complete lack of—documentation, on the other hand, you notice.

In open source communities, software and the personalities behind it tend to get the glory, while documentation—if it exists—is an afterthought, which really is too bad. The power of good (or bad) documentation shouldn't be ignored.

Today we're kicking off Doc Dish, a new community column dedicated to documentation, and we're looking for contributors.

Our first article is by Rich Bowen, based on one of his conference talks. After I saw him give the talk recently at ApacheCon in Austin, I resisted the urge to stand up and clap. Instead, I asked him to help us kick off our column, which led to his article: RTFM? How to write a manual worth reading.

As you'll see in his article, Rich doesn't have documentation training per se, but he has been creating and improving docs for a couple of decades and has given the topic a lot of thought. He explains how documentation says a lot about your project and community. Even well-written documentation, for example, can send a message about what kind (not kinds) of people work on it. And he shows how something as small as an error message falls under the documentation umbrella. His article also offers a bunch of tips and links to additional resources, so be sure to check it out.

If you or your project would like to contribute to the new documentation column, email us an article proposal, with a brief outline and author bio. Let us know if you have questions about how to submit an article or if you need more information. And remember: Good documentation is good thinking.

Doc
Dish

This article is part of the Doc Dish column coordinated by Rikki Endsley. To contribute to this column, submit your story idea or contact us at open@opensource.com for more details.

About the author

Rikki Endsley - Rikki Endsley is a community architect and editor for Opensource.com. In the past, she worked as the community evangelist on the Open Source and Standards (OSAS) team at Red Hat; a freelance tech journalist; community manager for the USENIX Association; associate publisher of Linux Pro Magazine, ADMIN, and Ubuntu User; and as the managing editor of Sys Admin magazine and UnixReview.com. Follow her on Twitter at: @rikkiends.
https://opensource.com/business/15/5/cfp-documentation-articles
opensource.com
crawl=CC-MAIN-2018-43
64920
application/http; msgtype=response
sha1:VIYTTJPLNKUH5APUEDE7I5NTKONGZNVV
<urn:uuid:a9a47c02-6988-4008-8852-06f03c786234>
2018-10-20T09:31:34Z
54.204.39.132
text/html
sha1:RCKCV42AEGYKNUBJVHJ5F2QCUTKUFE7S
<urn:uuid:b2230621-344e-4d00-9f49-f15db263721d>
https://opensource.com/business/15/5/cfp-documentation-articles
response
<urn:uuid:626dd8fb-30c1-4761-b891-758ea546090f>
isPartOf: CC-MAIN-2018-43
publisher: Common Crawl
description: Wide crawl of the web for October 2018
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-93-236-233.ec2.internal
software: Apache Nutch 1.15 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 0.11-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/