Technical documentation

By Kevin Hanson Do you have a new software project on the horizon? You should prepare for success. The process of development determines the outcome. And a crucial part of making sure things run smoothly is having the right documentation in place. B...

Are you beginning your journey as a technical writer? Explore this post to discover commonly used technical writing examples.

Technical documentation is the foundational information about the underlying architecture, materials, and process for interfacing with, or building on top of, existing technology. In software, technical documentation outlines the various API routes and endpoints the developer can access. Documentation helps others (and sometimes yourself) verify and validate the results.After building our innovative apps and products we must provide detailed directions for users to find their way as well.

Nous avons décidé d'utiliser l'architecture CQRS (Command and Query Responsibility Segregation) pour notre logiciel. Voici les raisons de ce choix.

For as long as we’ve had tools we need help using (and language to talk to each other), we’ve had technical documentation. (Don’t believe me? The first example of technical writing in English dates back to the Middle Ages when Chaucer wrote a guide to the astrolabe—a device used for measuring...

We are trying to do a story mapping session for a new project (a student portal). Since this is my first time doing this and we don't have a business analyst in the team that could help me, I'm

Technical Writing

In this post, you’ll learn what technical writing is and how it differs from other types of writing.

Turn visions into reality with requirement documents: Your PRD for clear direction and teamwork.

Product requirement document (PRD) provides the groundwork for the successful development and management of an app, product, or project. Learn what a PRD is, what it should include, and how it can be used for success.