Tag Archives: Style Guide
Jan
The quality of your screenshots affects how customers perceive your products, use your software, and deal with error messages.
The following guidelines can be applied to different types of technical and business documents. The final section provides screenshot guidelines for Android and iOS applications, for example, if you want to submit apps to Google Play or iTunes.
Jan
Here are some guidelines that have helped me, tailored specifically for writing white papers—a format that demands clarity, credibility, and persuasion.
Jan
If you use Microsoft Word to write lengthy documents, you may have experienced crashes, slow performance, or file corruption. These issues are especially common in documents exceeding 100 pages. Below are seven detailed tips to help you maintain the stability and performance of your long Word documents.
Jan
1 Minute Writing Tip: Do you need a colon before a list? Or would a comma work instead? Let’s break it down.
Jan
In the following article, I’ll outline the process of defining, writing, and sharing your style guide. These steps can be adapted to most large language models (LLMs). Subsequent articles will go into the specific elements and structure of an effective style guide.
Jun
Your product has to compete with an increasing number of rivals. When you do land a prospective customer, make sure that the instructions are easy to follow, relevant, and unambiguous. Let’s look at two examples from Apple and Microsoft’s guidelines for web writing.
How To, How to Write, MS Word, Technical Writing, Technical Writing Tutorials, User Guides
The ‘Accidental’ Proofreader: 7 Ways to Refine Technical Texts
Jun
Remember, consistent practice is key to improving your proofreading skills. In addition to the above suggestions, I’d suggest that you look at proofreading as a separate task in the document development process.
For example, if you use software like Jira/Trello to manage your writing projects, add a specific ticket for proofreading. This ensures you carve out enough time to perform this task before you send the documents out to customers.
May
A few weeks ago I wrote that I didn’t like business writing when I started out. Why? Well, it took me several centuries to write very long white papers, data sheets, and other sales collateral. Strange word ‘collateral’ isn’t it? The main reason we did this was the ‘assumption’ that customers preferred lengthy documents. These doorstoppers covered all aspects of the product/service. Sure, it had its place. But not all documents have to land with a thud. It’s the same with writing Business Plans. It doesn’t have to be fifty pages if you can get it under twenty and keep the material focused.
May
When writing technical documents, especially those that have gone through multiple revisions, what you initially set out to write and what appears in the review document may differ. In addition, you’re probably fatigued from wordsmithing the text and want to move on to something else. Nonetheless, as your name is on the document, it’s critical that you can stand by what you’ve written.
So, let’s look at how to review a technical document. Before I start, it’s assumed you’ve spellchecked the text, checked your sources, and so forth.
Jan
If you use tables in your business or technical documents, the following guidelines will help you structure and format data in your tables correctly. Use tables to help readers understand large amounts of data which otherwise may take several paragraphs to describe. How to Format a Table The APS Style Manual recommends that “Tabular material […]
Looking for tips to format Business Proposals? These writing guidelines will help with Sales, Grant, Government and Research Proposals.
- 1
- 2
