In the introduction section, identity the software you are about to install, steps to prepare for installation, running installation scripts, and post-installation tasks after the installation script has completed. In general, your installation guide will include most of the following: Introduction Choose the Installation Type Concepts Setup Pre-Installation Requirements Pre-Installation Checklist Installation and Configuring Procedure […]
9 Ways To Peer Review Technical Documents
I’ve always had mixed feelings about peer reviews. What they’re done right, we all learn but like Lesson Learned review can easily degenerate into bitching sessions if not managed correctly.
How To Make Friday Your Busiest Day
lance-armstong-getting-things-done Friday is my busiest day. Most folks power down and go into weekend mode. Not here! Ask yourself, ‘why do I go down a gear on Friday?’, ‘How does this benefit my career?’ Ok, let’s be honest. We do this because others do it. Right? This is a high-risk way to manage your career. You’re letting others determine how you behave. And it damages your career in many, many ways. Here’s an alternative approach.
How To Write Technical Documentation For REST/Web APIs
Why write API reference documentation? If your company develops APIs, then you can provide reference documentation for each API available with the product. The API documentation should describe the common components used by each of the APIs for iOS, Android, and other platforms. Essentially, the API reference documentation explains the data structures available through the APIs. […]
Put Your Words on a Diet
Goethe once wrote to a friend, “If I had more time, I’d have sent you a shorter letter.” Here’s why.