API documentation
What exactly do we mean by API documentation? As you know, an API (Application Programming Interface) is a set of software calls that allows a program to interact with other programs, databases, or other local or network resources. Instead of writing software to...
Structured documentation with CCMS
Professionals in the technical/commercial documentation field do not use Word, and often not even InDesign or similar. Rather, they use more advanced software tools to create content and, separately, to assemble and publish that content in multiple formats....
Writing to communicate value
Manuals, Guides, Presentations… What does it mean to write in a way that best communicates the value of technology? Is it enough to list product or service features, specifications, installation, troubleshooting? Here’s a quick walkthrough of how we can...
Operation and Maintenance Manuals
What should an Operation and maintenance manual say? Whatever format you choose, how should this document be structured to adequately cover its objectives? Regarding operating instructions or information for equipment and machinery, there is the international standard...
ChatBots and artificial intelligence: writing today for tomorrow’s applications
We live in a time when the media is full of announcements about generative applications of artificial intelligence, often already integrated in work packages. The language models (LLMs) underlying these solutions, trained for direct conversation, can then be adapted...
Write once, write well, reuse!
Like software code, whose methods over the years have defined a modular, object-oriented approach with structured libraries, the field of technical and business documentation has gradually organized itself to work more efficiently. How often does it happen that we...
