Show More
Menu
Image
Hi there! I am Federico Trotta

Technical Writer

All posts tagged in documentation

  • Image

    03/03/2024

    Docs-as-code: Why You Should Treat Documentation as Code

    When starting a documentation implementation strategy for software, one of the methodologies you can choose is the so-called “docs-as-code” philosophy which means treating documentation as if it were code. This article describes the characteristics of the doc-as-code methodology, and why use it. Features of the docs-as-code methodology Applying the docs-as-code methodology and treating documentation like

  • Image

    03/03/2024

    Docs-as-code: Perché Trattare la Documentazione Come il Codice

    Quando si deve iniziare una strategia di implementazione della documentazione per il software, una delle metodologie che si possono scegliere è la cosiddetta filosofia “docs-as-code” che non significa nient’altro che trattare la documentazione come fosse codice. In questo articolo vediamo quali sono le caratteristiche della metodologia doc-as-code e perché utilizzarla. Caratteristiche della metodologia docs-as-code Applicare

  • Image

    19/02/2024

    How To Measure Documentation Quality?

    In engineering, measurement is the only way to improve. But when we talk about documentation, a question arises: how do we measure the documentation quality? When it comes to quality, I like to maintain a “manufacturing” approach, in the sense that I understand quality as something that makes the customer happy. But how do we

  • Image

    19/02/2024

    Come Si Misura La Qualità Della Documentazione?

    Nel campo dell’ingegneria, misurare è l’unico modo per poter migliorare. Ma quando si parla di documentazione una domanda sorge spontanea: come si misura la qualità della documentazione? Quando si parla di qualità, a me piace mantenere un approccio “manifatturiero”, nel senso che intendo la qualità come quel qualcosa che rende felice il cliente. Ma come

  • Image

    22/01/2024

    How Technical Documentation Helps Sales Selling More

    Let’s consider a typical scene: the software is stable enough and your product is ready for sale. You start with sales and the first customers arrive, but… they have difficulty using your product! As a result, they open support tickets, contact customer care, or write to the sales representative to understand how to use it

  • Image

    22/01/2024

    Come la Documentazione Tecnica Ti Aiuta Nella Vendita del Software

    Prendiamo in considerazione una scena tipica: il software è abbastanza stabile ed il tuo prodotto è pronto per la vendita. Parti con le vendite ed iniziano ad arrivare i primi clienti, ma…hanno difficoltà ad usare il tuo prodotto! Risultato: aprono ticket al supporto, contattano il customer care, o scrivono al sales di riferimento per capire

  • Image

    18/01/2024

    3 Reasons Why You Shouldn’t Entrust Your Technical Documentation to an Agency

    The moment has come. You’ve finally made the decision: you need a Technical Writer. They will have a lot of work to do: the product is quite mature, you have problems with customers who open a lot of support tickets because they don’t know how to use the product, overloading the support engineers with work,

  • Image

    18/01/2024

    3 Ragioni Per Cui Non Dovresti Affidare la Documentazione Tecnica ad una Agenzia

    E’ arrivato il momento. Hai finalmente preso la decisione: ti serve un Technical Writer. Di lavoro ne avrà da fare: il prodotto è abbastanza maturo, hai problemi di clienti che ti aprono un sacco di ticket di supporto perché non sanno usare il prodotto, sovraccaricando di lavoro gli ingegneri del supporto, e vorresti anche valutare

  • Image

    15/01/2024

    Release Notes: Come Implementarle in un Ambiente a Rilasci Frequenti

    NOTA: puoi leggere questo articolo in inglese qui. Quando si crea la documentazione legata al software e al prodotto, le release notes sembrano facili da implementare: quasi una banalità. La verità è che dipende dall’ambiente in cui stiamo lavorando. C’è molta differenza tra essere un Technical Writer in un’azienda grande e strutturata ed in un’azienda

  • Image

    15/01/2024

    Release Notes: How to Implement Them in a Fast Delivery Environment

    NOTE: do you want to read this article in Italian? It’s here. When creating software and product documentation, release notes seem easy to implement. Almost a banality. The truth is that it depends on the environment we’re working on. There’s a lot of difference between being a Technical Writer in a corporation and a small-sized