Bad Manuals: How to Tell If Your Manual Needs An Overhaul
Bad manuals make you look unprofessional. Here’s a checklist to evaluate whether you have bad manuals that frustrate customers and undercut your brand.
content development
3 Technical Communication Workflows to Save You Time
Technical communication workflows provide a time-saving framework for effective project management.
Work-from-Home Attire Isn’t Always Pretty
Work-from-home attire is more sweats that suits. Here are some raw, humorous trends that don’t look great, but boost job satisfaction and productivity.
Content Development SEO Case Study: A Shoe Mystery
Content development SEO turns a web writer into a modern Sherlock Holmes. Our case study in web content development SEO explains how to improve engagement.
ProEdit’s use of 3D design software lowers costs, improves manuals
ProEdit’s cutting-edge use of 3D design software has drawn the attention of Dassault Systemes, who published a case study showcasing how ProEdit uses 3D technical illustration tools to improve the manuals it creates and reduce the cost of creating them. “Our clients often ask us to create manuals that are illustration-heavy and word-light in an …
How to Forecast Updating Your Company’s Content
If you get the feeling of déjà vu when you sit down to revise outdated materials, you aren’t alone. Companies spend countless hours and budgeted dollars keeping their existing content up to date, whether they are refreshing product information manuals, policy and procedure manuals, training materials, website content, or the like. In fact, studies have …
How to Write for an Eighth-Grade Reading Level
When writing documentation, marketing content, or training materials, keeping the audience in mind is an important step in producing effective content. Sometimes, you may be asked to limit your writing to a specific reading level so it’s accessible to a broad range of users. You can monitor the reading level of a document by turning …
Best Practices for Planning an Instructional Design Project
Successful projects start with detailed planning. Before you even begin the design phase for your instructor-led training (ILT) course or elearning module, you should have a clear understanding of the project, including its requirements, purpose, audience, deadline, and schedule. Building this solid foundation will help keep you organized and on-track. What Are the Requirements? A …
The Importance of Review Cycles in a Project
Each project has unique requirements, so we tailor our approach to ensure that the work effort meets the goals of the project in the way best suited for its success. Among the techniques that we’ve developed to make sure the structure of a project contributes to its timely and successful completion is to include review …
Planning a Technical Writing Project
Are you planning a technical writing project? As a technical writer or technical writing manager, creating a documentation plan is essential to the success of your next project. A documentation plan is an overview of the entire project from the perspective of a technical writer. This plan is drafted in the early stages of the …