documentation

Translating documentation takes time and effort, but not nearly as much as starting over from scratch. With a few tips, you can streamline the translation process and get readable, useful results.
1 comment Posted 1 Jul 2015 by Greg Pittman Feed
Which came first, the program or the documentation? Therein lies the dilemma.
0 comments Posted 29 Jun 2015 by David Both Feed
Typewriter keys
In part one of a three-part series, we explore how to apply content strategy principles to technical documentation, so that we can create the right content, for the right users, and deliver it to them at the right place and at the right time.
3 comments Posted 25 Jun 2015 by Mikey Ariel (Red Hat) Feed
Open Source in Education chalkboard
Teachers learn how to create curriculum courses through a sprint. The sprint was supported by a National Science Foundation (NSF)-funded project to investigate the potential for student learning from a professional open source community (called "vertical teaming").
0 comments Posted 24 Jun 2015 by Gina Likins (Red Hat) Feed
Image of typewriter keys
Writing documentation is easier than you think, and with the help of a template, getting started is even easier.
1 comment Posted 23 Jun 2015 by Jan Niggemann Feed
Typewriter keys
The documentation journey starts at the mailing list and never ends. In this article, Greg Pittman explains how he started writing documentation for Scribus, an open source desktop publishing application.
2 comments Posted 11 Jun 2015 by Greg Pittman Feed
pink typewriter
Five practical reasons to use a rendered language instead of wikis to publish your open source project documentation.
3 comments Posted 4 Jun 2015 by Ben Cotton Feed
Typewriter keys
The best documentation is what actually gets written, so always favor a wiki over no documentation at all.
3 comments Posted 1 Jun 2015 by Ben Cotton Feed
Typewriter in grass
Writers wanted for a new Opensource.com column dedicated to documentation, including best practices, case studies, projects that need help from the community, events, tools, and tips.
0 comments Posted 14 May 2015 by Rikki Endsley (Red Hat) Feed
No swimming sign with alligator biting it
Patience and empathy are the basis of good documentation, much as they are the basis for being a decent person. Here's a how-to for creating better open source project docs, which can help your users and grow your community.
22 comments Posted 14 May 2015 by Rich Bowen (Red Hat) Feed

Pages