Python has recently overtaken Java to become the second most popular programming language in the world. Most news articles and people give examples of its penetration in the software development world, however that is simply the tip of it.
For those who may remember, Visual Basic also took the world by storm in much the same way. VB made it possible for users to convert MS Word and Excel into customized applications. This was way before Access and of course the proliferation of web-based applications.
Unlike Java, Python can be installed on an average PC by using a few commands. It installs very smoothly on tablets with Linux; and with a small footprint Python gives users the power to write and run programs.
Here is a simple CLI (Command Line Interface) program that can be written with built-in libraries.
Search text (string) in a text block and returns its location if found.
With a few more lines of code and complexity, the program could read the text block from a file. And then with a few more, it can save the sentence or paragraph that contains the searched strings to a different file.
Python, unlike other programming languages, also ships with a basic development environment. Whereas it is doesn’t meet the needs of those writing software or web applications, it is more than enough for everyone else. Python has found a unique place in the world of mathematics, because it makes a variety of computation accessible and free.
When in Rome, do what the Romans do.
Do you need to understand the language and customs of a new place you visit? Would you rather be in the know than out of the loop?
Granted, your role is to document the software or the development process, and being able to understand the content is primordial. Even proof-readers know that their suggestions could alter the meaning of the sentence.
One of the features of Python is that it is very accessible. Even if you choose not to use Python in your documentation process, which you really should, it is a programming language you simply cannot ignore. In addition to the language, you may also have to familiarize yourself with commonly used development frameworks and practices. For these your best guide will be the program writers themselves.
3 ways Python can help with Documentation:
1. Speed up repeated tasks
- search a code base for keywords or strings
- create a list of functions, variables or other types
- convert lists into spreadsheets or convert spreadsheets into files
Download code for Search a file for keywords or strings from GitHub
2. Consolidate Data
- Collate data from different files and locations
- Extract a Glossary of Terms
- Programmatically add a glossary to a file
3. Evaluate against a Template
This is easily done for documentation that follows an outline or template. As your project grows, you will be able to evaluate your work against these templates.
- Identify empty content sections
- Identify missing catch phrases or words in content sections
Getting started
To help you get started on Python, you can download Python from here.
