際際滷

際際滷Share a Scribd company logo
1
Come avviare un progetto di
documentazione
COM&TEC Italia, Novembre 2016
Avviare il progetto
≒Failing to prepare is
preparing to fail
In mancanza di
pianificazione, ci si
appresta a fallire!
Marcel
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
Iniziare ?
5
 Doc needs
 Tools
 Constraints
 Deliverables
Pianificare? La Doc
necessaria
 Definizione dei bisogni di documentazione
 Interrogare il:
 Product manager
 Marketing
 Sales manager
 Training?
6
 Doc needs
 Tools
 Constraints
 Deliverables
Contatti/inquieste: essenziale!
7
La Doc necessaria:
distribuibili (1)
 Guida Utente
 Guida allInstallazione
 Guida alla Manutenzione
 Guide alla risoluzione dei problemi
 Reference guide
 Supporto alla formazione
8
 Doc needs
 Tools
 Constraints
 Deliverables
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
Supporto alla formazione:
esempio (1)
10
Si parla al
formatore
Supporto alla formazione:
esempio (2)
11
Supporto alla formazione:
esempio (3)
12
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
Video?
14
Distribuibili
 Carta
 Testo, Screenshots, fumetti
 Elettronica
 Online help
 Web portal (Knowledge base, wiki, FAQ)
 Mobile
 CD-Rom
15
 Doc needs
 Tools
 Constraints
 Deliverables
Wiki or not Wiki?
16
Wiki: scelta sbagliata (1)
 niente 束 version control 損
 nessuna struttura
 difficile trovare rapidamente
linformazione ricercata
17
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
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
Distribuibili
 Supporto mobile (mobile, tablets)
 Connected Objects (IoT)
 Twitter
 Audio?
 Google Glass
20
 Doc needs
 Tools
 Constraints
 Deliverables
Esempio: QR code Doc needs
 Tools
 Constraints
 Deliverables
Tools (i strumenti)
 Software
 Hardware
 Licenze
 Aggiornamenti
22
 Doc needs
 Tools
 Constraints
 Deliverables
Software
 MS Word
 Open Office
 Paint
 SnagIt
 PowerPoint
 Single-Source
 XML
 DITA
 Madcap Flare
23
 Doc needs
 Tools
 Constraints
 Deliverables
Hardware
 Laptop
 Desktop
 CD ?
 Hard Disk capacity (spazio disponibile?)
24
 Doc needs
 Tools
 Constraints
 Deliverables
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
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 thats it. Dont use it for
online presentation.
26
Il prodotto
 Nuovo
 Update/aggiornamenti
 Competitors
 Obiettivo corporate
 Doc needs
 Tools
 Constraints
 Deliverables
Vincoli
 Tempo
 Risorse
 Formazione dei communicatori?
 Disponibilit degli SMEs (Subject
Matter Experts)
 Disponibilit del prodotto (versione
finale? )
28
 Doc needs
 Tools
 Constraints
 Deliverables
Formazione dei communicatori:
problemi  esempio (1)
29
Madcap Flare
Discussion
group
 Doc needs
 Tools
 Constraints
 Deliverables
Formazione dei communicatori:
problemi  esempio (2)
30
 Doc needs
 Tools
 Constraints
 Deliverables
Vincoli di produzione
 Standards
 Machine Industry ?
束 Guida allapplicazione della direttiva
macchine 損
 Medical: ISO 13485 (medical device)
 ISO 26 514
 ISO 82 079
 ecc
31
 Doc needs
 Tools
 Constraints
 Deliverables
Vincoli di produzione
 Traduzione
 Localizzazione
 Limiti di volume: quante pagine?
32
 Doc needs
 Tools
 Constraints
 Deliverables
Sommario (1)
 Doc needs:
 Quale 束distribuibili損
 Strumenti
 Tools disponibili per i communicatori
tecnici
 Esperienza dei communicatori (training)
33
Esperienza redattori (rischio):
DITA
34
Summary (2)
 Vincoli
 Tempo
 Risorse
 Standards
 Disponibilit prodotto
 Distribuibili
35
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
Domande?...
flacke@orange.fr

More Related Content

Documentation tecnica : Gestione progetto

  • 1. 1
  • 2. Come avviare un progetto di documentazione COM&TEC Italia, Novembre 2016
  • 3. Avviare il progetto ≒Failing to prepare is preparing to fail In mancanza di pianificazione, ci si appresta a fallire! Marcel
  • 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. Iniziare ? 5 Doc needs Tools Constraints Deliverables
  • 6. Pianificare? La Doc necessaria Definizione dei bisogni di documentazione Interrogare il: Product manager Marketing Sales manager Training? 6 Doc needs Tools Constraints Deliverables
  • 8. La Doc necessaria: distribuibili (1) Guida Utente Guida allInstallazione Guida alla Manutenzione Guide alla risoluzione dei problemi Reference guide Supporto alla formazione 8 Doc needs Tools Constraints Deliverables
  • 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. Supporto alla formazione: esempio (1) 10 Si parla al formatore
  • 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
  • 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. Wiki or not Wiki? 16
  • 17. Wiki: scelta sbagliata (1) niente 束 version control 損 nessuna struttura difficile trovare rapidamente linformazione ricercata 17
  • 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. 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. Distribuibili Supporto mobile (mobile, tablets) Connected Objects (IoT) Twitter Audio? Google Glass 20 Doc needs Tools Constraints Deliverables
  • 21. Esempio: QR code Doc needs Tools Constraints Deliverables
  • 22. Tools (i strumenti) Software Hardware Licenze Aggiornamenti 22 Doc needs Tools Constraints Deliverables
  • 23. Software MS Word Open Office Paint SnagIt PowerPoint Single-Source XML DITA Madcap Flare 23 Doc needs Tools Constraints Deliverables
  • 24. Hardware Laptop Desktop CD ? Hard Disk capacity (spazio disponibile?) 24 Doc needs Tools Constraints Deliverables
  • 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. 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 thats it. Dont use it for online presentation. 26
  • 27. Il prodotto Nuovo Update/aggiornamenti Competitors Obiettivo corporate Doc needs Tools Constraints Deliverables
  • 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. Formazione dei communicatori: problemi esempio (1) 29 Madcap Flare Discussion group Doc needs Tools Constraints Deliverables
  • 30. Formazione dei communicatori: problemi esempio (2) 30 Doc needs Tools Constraints Deliverables
  • 31. Vincoli di produzione Standards Machine Industry ? 束 Guida allapplicazione della direttiva macchine 損 Medical: ISO 13485 (medical device) ISO 26 514 ISO 82 079 ecc 31 Doc needs Tools Constraints Deliverables
  • 32. Vincoli di produzione Traduzione Localizzazione Limiti di volume: quante pagine? 32 Doc needs Tools Constraints Deliverables
  • 33. Sommario (1) Doc needs: Quale 束distribuibili損 Strumenti Tools disponibili per i communicatori tecnici Esperienza dei communicatori (training) 33
  • 35. Summary (2) Vincoli Tempo Risorse Standards Disponibilit prodotto Distribuibili 35
  • 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