Skip to content

TechRepublic

  • Top Products Lists
  • Developer
  • 5G
  • Security
  • Cloud
  • Artificial Intelligence
  • Tech & Work
  • Mobility
  • Big Data
  • Innovation
  • Cheat Sheets
  • TechRepublic Academy
  • CES
  • TechRepublic Premium
  • Top Products Lists
  • Developer
  • 5G
  • Security
  • Cloud
  • Artificial Intelligence
  • Tech & Work
  • Mobility
  • Big Data
  • Innovation
  • Cheat Sheets
  • TechRepublic Academy
  • CES
  • See All Topics
  • Sponsored
  • Newsletters
  • Forums
  • Resource Library
TechRepublic Premium
Join / Sign In
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

TechRepublic Premium

  • TechRepublic Premium

    Employee performance review policy

    PURPOSE The purpose of this policy from TechRepublic Premium is to provide guidelines for employee performance reviews, which will clearly document accomplishments and areas of opportunity via an encouraging and thought-provoking analysis. This will assist in determining the next steps for employees as well as their future at the organization. This policy can be customized ...

    Published:  March 20, 2023, 12:00 PM EDT Modified:  March 21, 2023, 4:00 PM EDT Read More See more TechRepublic Premium
  • TechRepublic Premium

    Employee time off policy

    PURPOSE The purpose of this policy from TechRepublic Premium is to provide guidelines for requesting, filing and permitting paid/unpaid time off as well as to ensure coverage during holidays, vacation(s) and other absences where staffing levels must be consistent to meet the needs of the business. From the policy: TIME OFF GUIDELINES All time off ...

    Published:  March 20, 2023, 12:00 PM EDT Modified:  March 21, 2023, 4:00 PM EDT Read More See more TechRepublic Premium
  • TechRepublic Premium

    Employee privacy policy

    PURPOSE This policy describes the organization’s employee privacy guidelines and outlines employee privacy expectations. From the policy: POLICY DETAILS The organization’s IT equipment, services and systems are intended for business use only. However, the organization acknowledges that staff, consultants and volunteers occasionally require opportunities to make or receive personal phone calls, access personal email, utilize ...

    Published:  March 19, 2023, 12:00 PM EDT Modified:  March 20, 2023, 4:00 PM EDT Read More See more TechRepublic Premium
  • TechRepublic Premium

    Security response policy

    PURPOSE The purpose of this Security Response Policy from TechRepublic Premium is to outline the security incident response processes which must be followed. This policy will assist to identify and resolve information security incidents quickly and effectively, thus minimizing their business impact and reducing the risk of similar incidents recurring. It includes requirements for both ...

    Downloads
    Published:  March 19, 2023, 12:00 PM EDT Modified:  March 20, 2023, 4:00 PM EDT Read More See more TechRepublic Premium

Services

  • About Us
  • Newsletters
  • RSS Feeds
  • Site Map
  • Site Help & Feedback
  • FAQ
  • Advertise
  • Do Not Sell My Information

Explore

  • Downloads
  • TechRepublic Forums
  • Meet the Team
  • TechRepublic Academy
  • TechRepublic Premium
  • Resource Library
  • Photos
  • Videos
  • TechRepublic
  • TechRepublic on Twitter
  • TechRepublic on Facebook
  • TechRepublic on LinkedIn
  • TechRepublic on Flipboard
© 2023 TechnologyAdvice. All rights reserved.
  • Privacy Policy
  • Terms of Use
  • Property of TechnologyAdvice