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
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
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
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
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