Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Documentation tecnica : Gestione progetto

15 views

Published on

Come avviare un progetto di documentazione tecnica ?

Published in: Software
  • Be the first to comment

  • Be the first to like this

Documentation tecnica : Gestione progetto

  1. 1. 1
  2. 2. Come avviare un progetto di documentazione COM&TEC Italia, Novembre 2016
  3. 3. Avviare il progetto •“Failing to prepare is preparing to fail” •In mancanza di pianificazione, ci si appresta a fallire! Marcel …
  4. 4. Pianificare • Definire le necessità e che tipo di documentazione produrre • Elencare gli strumenti • Elencare I vincoli • Standards? • Vincoli di tempo • Definire gli output distribuibili 4 • Doc needs • Tools • Constraints • Deliverables
  5. 5. Iniziare ? 5 • Doc needs • Tools • Constraints • Deliverables
  6. 6. Pianificare? La Doc necessaria • Definizione dei bisogni di documentazione • Interrogare il: • Product manager • Marketing • Sales manager • Training? 6 • Doc needs • Tools • Constraints • Deliverables
  7. 7. Contatti/inquieste: essenziale! 7
  8. 8. La Doc necessaria: distribuibili (1) • Guida Utente • Guida all’Installazione • Guida alla Manutenzione • Guide alla risoluzione dei problemi • Reference guide • Supporto alla formazione 8 • Doc needs • Tools • Constraints • Deliverables
  9. 9. Risoluzione dei problemi: esempio • Information developers recognize that a high percentage of users seek information only when they experience a problem. (*) • However, most manuals “pose formidable obstacles to finding problem-solving information.” (*) • A Troubleshooting guide is probably the only guide users want because it is really useful (*) JoAnn Hackos in DITA-XML.org
  10. 10. Supporto alla formazione: esempio (1) 10 Si parla al formatore
  11. 11. Supporto alla formazione: esempio (2) 11
  12. 12. Supporto alla formazione: esempio (3) 12
  13. 13. Doc. Needs: distribuibili (2) • Video • Documentazione « embedded » • Release Notes • Quick Start Guide • Documentazione per la formazione • E-learning • Frontale 13 • Doc needs • Tools • Constraints • Deliverables
  14. 14. Video? 14
  15. 15. Distribuibili • Carta • Testo, Screenshots, fumetti • Elettronica • Online help • Web portal (Knowledge base, wiki, FAQ) • Mobile • CD-Rom 15 • Doc needs • Tools • Constraints • Deliverables
  16. 16. Wiki or not Wiki? 16
  17. 17. Wiki: scelta sbagliata (1) • niente « version control » • nessuna struttura • difficile trovare rapidamente l’informazione ricercata 17
  18. 18. Wiki: scelta sbagliata (2) “[Wikis are] not well-suited for re-publishing in other formats or offline editing. Keeping the content organized such that it can be found easily can be challenging. Unorganized wikis are particularly prone to duplicated and stale content.“ http://info.zoominsoftware.com/hubfs/ebook/Why_Not_Wiki.pdf?t=1478185300448 18
  19. 19. FAQ? “FAQ has a deeper problem. From a customers’ perspective it is a useless link. It is a classic example of organization-centric language. You force users to scroll through 40 FAQs to find what they're looking for. As a reader, scanning through 40 different questions that other people may have asked is not "quick" or "easy". Gerry McGovern http://www.ragan.com/Main/Articles/FAQ_and_Tools_are_useless_We b_links_42462.asp 19
  20. 20. Distribuibili • Supporto mobile (mobile, tablets) • Connected Objects (IoT) • Twitter • Audio? • Google Glass 20 • Doc needs • Tools • Constraints • Deliverables
  21. 21. Esempio: QR code• Doc needs • Tools • Constraints • Deliverables
  22. 22. Tools (i strumenti) • Software • Hardware • Licenze • Aggiornamenti 22 • Doc needs • Tools • Constraints • Deliverables
  23. 23. Software • MS Word • Open Office • Paint • SnagIt • PowerPoint • Single-Source • XML • DITA • Madcap Flare 23 • Doc needs • Tools • Constraints • Deliverables
  24. 24. Hardware • Laptop • Desktop • CD ? • Hard Disk capacity (spazio disponibile?) 24 • Doc needs • Tools • Constraints • Deliverables
  25. 25. Match doc needs tools • Release notes • Online help • Video • Long manuals MS Word, .txt  Robohelp  Camtasia FrameMaker o combined ? 25 • Doc needs • Tools • Constraints • Deliverables
  26. 26. Tutto .PDF? “user experience is dreadful (time to download, searchability, ...)” Jakob Nielsen: “Users get lost inside PDF files, which are typically big, linear text blobs that are optimized for print and unpleasant to read and navigate online. PDF is good for printing, but that’s it. Don’t use it for online presentation.” 26
  27. 27. Il prodotto • Nuovo • Update/aggiornamenti • Competitors • Obiettivo corporate • Doc needs • Tools • Constraints • Deliverables
  28. 28. Vincoli • Tempo • Risorse • Formazione dei communicatori? • Disponibilità degli SMEs (Subject Matter Experts) • Disponibilità del prodotto (versione finale? ) 28 • Doc needs • Tools • Constraints • Deliverables
  29. 29. Formazione dei communicatori: problemi – esempio (1) 29 Madcap Flare Discussion group • Doc needs • Tools • Constraints • Deliverables
  30. 30. Formazione dei communicatori: problemi – esempio (2) 30 • Doc needs • Tools • Constraints • Deliverables
  31. 31. Vincoli di produzione • Standards • Machine Industry ? « Guida all’applicazione della direttiva macchine » • Medical: ISO 13485 (medical device) • ISO 26 514 • ISO 82 079 • ecc 31 • Doc needs • Tools • Constraints • Deliverables
  32. 32. Vincoli di produzione • Traduzione • Localizzazione • Limiti di volume: quante pagine? 32 • Doc needs • Tools • Constraints • Deliverables
  33. 33. Sommario (1) • Doc needs: • Quale «distribuibili» • Strumenti • Tools disponibili per i communicatori tecnici • Esperienza dei communicatori (training) 33
  34. 34. Esperienza redattori (rischio): DITA 34
  35. 35. Summary (2) • Vincoli • Tempo • Risorse • Standards • Disponibilità prodotto • Distribuibili 35
  36. 36. Bibliografia • Information Development, Managing your documentation projects, portfolio and people, JoAnn Hackos, Wiley ed. • Project Management for Technical Documentation, A.J. Marlow, Marlow Durndell Publishing • Usability 101, Jakob Nielsen https://www.nngroup.com/articles/usability-101-introduction- to-usability/ 36
  37. 37. Domande?... flacke@orange.fr

×