Industry Articles
Find out what’s happening in software documentation
Technical Writing Courses Coming Soon!
I’m developing two technical writing courses. The beginner course will help new people to gain the skills needed for the software industry. The Agile course will help existing technical writers to function and thrive in teams using Scrum, Lean, Kanban, and other Agile methodologies.
Read more
Creating Manuals Using RST and Sphinx: Text Formatting
ReStructuredText is one of the more persnickety documentation ‘languages’ out there. Blank lines and spaces can often be the difference between a lovely end document and absolute chaos. In this post, I’m going through the basic text formatting options that you’ll need to create a clear, readable document.
Read more
5 Signs That Your Doco is Kick-Arse
I’ve talked a lot about how to improve your documentation. But what if your doco doesn’t need changing? How do you know when your doco is already awesome? Here are five signs to look for.
Read moreGet the Doc’s articles in your inbox
Receive an email whenever the Doc publishes a new article.
LET YOUR USERS LOVE YOU
Give your users a great experience from start to finish. Make sure that no matter what they need to find out, your doco can help them.
REINVENT YOUR INFORMATION
Documentation isn’t just PDFs and help files anymore. Move your documentation to new mediums and engage your users.
RENOVATE
Have your large, unwieldy collection of user manuals analysed, consolidated, and reorganised to better relate to your current user base.
DECADES OF EXPERTISE AT YOUR FINGERTIPS
Doc Kramer knows documentation
After decades working in the software industry to improve information streams to end users, Doc Kramer has the knowledge and expertise to get your information where it needs to go.
Are your manuals sick? Call in the Doc
New technologies open new and exciting ways for you to keep your customers in the loop. But sometimes it’s hard to identify key trends to jump on and where to get your best value for money.
MEET YOUR USERS’ NEEDS
Don’t tell them what you think they need to know; tell them what they need to know.
FLEXIBLE DELIVERY
Everyone learns differently. Find out how your users tick, and how you can help them get up to speed.
DOC LIKE CODE
Synchronise your code and its documentation, so they never get out of step again.
NEW GENERATION? NEW COMMUNICATION
Keep up with communication trends and meet your audience where they work and play.