Skip to content

TechRepublic

  • Top Products
  • AI
  • Developer
  • Payroll
  • Security
  • Project Management
  • Accounting
  • CRM
  • Academy
Resources
  • TechRepublic Premium
  • TechRepublic Academy
  • Newsletters
  • Resource Library
  • Forums
  • Sponsored
Go Premium
Popular Topics
  • Top Products
  • AI
  • Developer
  • Payroll
  • Security
  • Project Management
  • Accounting
  • CRM
  • Academy
  • Project Management
  • Innovation
  • Cheat Sheets
  • Big Data
  • Tech Jobs
View All Topics
Go Premium
Software

Five apps to take the pain out of documentation

By Jack Wallen May 20, 2014, 2:16 PM PDT

Image
1
of 5

documentation2istock000036016580small.jpg
documentation2istock000036016580small.jpg
Five apps to take the pain out of documentation

Five apps to take the pain out of documentation

MBM YAPR

Five apps to take the pain out of documentation

If you’re a system or network administrator or a programmer,rnyou know one of the most tedious exercises you can undertake is documenting yourrnsystems, networks, or projects. But without proper documentation, you mayrnas well build it all and forget how you did it — because that information willrnslip from your memory. Or worse, you’ll be relieved of your duties and thosernwho step in to fill your shoes will be clueless as to what you did.

So what’s the best way to approach it? Do you just open uprna word processor and start typing random bits of information? Or do you use an applicationrndesigned to simplify the process? It makes sense to take advantage of arnspecialized app, but which one should you use? Here’s a list ofrnfive useful apps that can simplify your documentation chores. They’re eitherrnspecific to a task or general enough to aid in most situations.

Note: This gallery is also available as an article.

MBM YAPR
Five apps to take the pain out of documentation

Sphinx

Sphinx

Yourrnfirst step will be to run the sphinx-quickstart, which will build the directoryrnstructure for your documentation. It will ask you numerous questions (in mostrncases, the default answers will work) and then instruct you to populate yourrnmaster file and create other documentation source files. After that, you runrnthe make builder command to build therndocuments.

Five apps to take the pain out of documentation

Geany

Geany

Geany isn’t just a simple cross-platform text editor. It’s an easy-to-userngraphical text editor that can handle your documentation tasks in XML formatrn(think DocBook). Geany features syntax highlighting, code folding, symbol namernauto-completion, auto-closing of XML and HTML tags, and call tips, among otherrnthings. It also supports a large list of file types.

Five apps to take the pain out of documentation

Geany

Geany

You can create projects within Geany and specify things likernfiletypes, encoding, and line endings on a per-project basis. Although Geany isrngeared more toward coding projects, it’s an outstanding tool to help yournconstruct your documentation. There is also a plug-in called GeanyGenDoc thatrnwill automatically generate documentation based on source code. To learn morernabout GeanyGenDoc, take a look at the online manual.

Five apps to take the pain out of documentation

Calibre

Calibre

Calibre also lets you generate a handy table of contents forrneasier documentation navigation.

  • Software
  • Account Information

    Share with Your Friends

    Five apps to take the pain out of documentation

    Your email has been sent

Share: Five apps to take the pain out of documentation
Image of Jack Wallen
By Jack Wallen
Jack Wallen is an award-winning writer for TechRepublic, The New Stack, and Linux New Media. He's covered a variety of topics for over twenty years and is an avid promoter of open source. For more news about Jack Wallen, visit his website jackwallen.
  • Account Information

    Contact Jack Wallen

    Your message has been sent

  • |
  • See all of Jack's content

Daily Tech Insider

If you can only read one tech story a day, this is it.

TechRepublic TechRepublic
  • TechRepublic on Facebook
  • TechRepublic on X
  • TechRepublic on LinkedIn
  • TechRepublic on YouTube
  • TechRepublic on Pinterest
  • TechRepublic RSS
Services
  • About Us
  • Newsletters
  • RSS Feeds
  • Site Map
  • Site Help & Feedback
  • FAQ
  • Advertise
  • Do Not Sell My Information
  • Careers
Explore
  • Downloads
  • TechRepublic Forums
  • Meet the Team
  • TechRepublic Academy
  • TechRepublic Premium
  • Resource Library
  • Photos
  • Videos
  • Editorial Policy
  • Legal Terms
  • Privacy Policy
© 2025 TechnologyAdvice. All rights reserved.
CLOSE

Create a TechRepublic Account

Get the web's best business technology news, tutorials, reviews, trends, and analysis—in your inbox. Let's start with the basics.

Already registered? Sign In
Use Facebook
Use Linkedin

* - indicates required fields

CLOSE

Sign in to TechRepublic

Not a member? Create an account
Use Facebook
Use Linkedin

Lost your password? Request a new password

CLOSE

Reset Password

Please enter your email adress. You will receive an email message with instructions on how to reset your password.

Check your email for a password reset link. If you didn't receive an email don't forgot to check your spam folder, otherwise contact support.

Back to login
1 Finish Profile
2 Newsletter Preferences
CLOSE

Welcome. Tell us a little bit about you.

This will help us provide you with customized content.

No thanks, continue without
1 Finish Profile
2 Newsletter Preferences
CLOSE

Want to receive more TechRepublic news?

Newsletter Name
Subscribe
Daily Tech Insider
Daily Tech Insider AU
TechRepublic UK
TechRepublic News and Special Offers
TechRepublic News and Special Offers International
Executive Briefing
Innovation Insider
Project Management Insider
Microsoft Weekly
Cloud Insider
Data Insider
Developer Insider
TechRepublic Premium
Apple Weekly
Cybersecurity Insider
Google Weekly
Toggle All
No thanks, continue without

You're All Set

Thanks for signing up! Keep an eye out for a confirmation email from our team. To ensure any newsletters you subscribed to hit your inbox, make sure to add [email protected] to your contacts list.

Back to Home Page
×