Industry Articles
Find out what’s happening in software documentation
Technical Writing and Cloud Technology
Cloud technology is huge in the technology world right now. Most experts predict that it’s only going to increase in market share. In this article, I’ll look at cloud technology from the perspective of technical writers. So I won’t be talking much about business objectives and advantages. Rather, I’m focusing on how cloud tech differs from traditional server technology. Then, I’ll look at what technical writers need to know in order to work in and with the cloud. And, for that matter, how we can future-proof our skill sets.
Read more
Creating Manuals Using RST and Sphinx: Child Documents
Child documents, or sub-documents, make up the bulk of a project. Think of them as Lego blocks – pieces of various sizes that can be put together to make all sorts of end documents. Each child document answers a single question, or addresses a single topic.
Read more
How to Develop Agile Documentation
Traditional software documents are created from the top down. Figure out who will be doing what with the software, then write documents aimed at each category of users, explaining how to use every bit of functionality they should (theoretically) need to use. This method really doesn’t fit in well with modern software design. So how can we use basic concepts from Agile methodology to develop Agile documentation?
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.