Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance: Contents, Structure, User Navigation
Even the best information is worthless if users can't find it. Providing user-friendly structure and navigation is just as important as providing well-written content. However, structuring user assistance isn't as simple and obvious as it may seem. If you think that your document structure should... Lue lisää
Even the best information is worthless if users can't find it. Providing user-friendly structure and navigation is just as important as providing well-written content. However, structuring user assistance isn't as simple and obvious as it may seem. If you think that your document structure should... Lue lisää
Even the best information is worthless if users can't find it. Providing user-friendly structure and navigation is just as important as providing well-written content. However, structuring user assistance isn't as simple and obvious as it may seem. If you think that your document structure should follow the structure of your product's components and functions: You're wrong. If you think that the type of document that you prefer is the same type of document that your clients prefer: You're wrong. If you think that all the information that you have is important: You're also wrong.This book tells you how to structure, index, and link your documents so that readers actually find the information they need.
Topics covered: General structuring principles that all structural decisions have in common.Choosing media: Should you provide a printed or printable user manual (PDF), online help, or both? What information should go into the user manual, and what information should go into online help? Which help format should you use? Can context-sensitive help calls be implemented? Should you provide interactive features?Planning documents: Should you put all information into one document, or should you supply several user manuals for specific purposes and user groups? How should you name your documents?Planning document sections: What are the major sections that your documents should consist of? Are there any standard sections that you mustn't forget?Planning topics: What types of information do your clients need? How should you build and name the individual topics within the document?Planning the order of sections and topics: How should you organize the sections and topics within your documents? What comes first? What comes later?Planning navigation: Which navigational devices should you provide in printed documents and in online help systems? Where should you provide links or cross-references and where not?
Topics covered: General structuring principles that all structural decisions have in common.Choosing media: Should you provide a printed or printable user manual (PDF), online help, or both? What information should go into the user manual, and what information should go into online help? Which help format should you use? Can context-sensitive help calls be implemented? Should you provide interactive features?Planning documents: Should you put all information into one document, or should you supply several user manuals for specific purposes and user groups? How should you name your documents?Planning document sections: What are the major sections that your documents should consist of? Are there any standard sections that you mustn't forget?Planning topics: What types of information do your clients need? How should you build and name the individual topics within the document?Planning the order of sections and topics: How should you organize the sections and topics within your documents? What comes first? What comes later?Planning navigation: Which navigational devices should you provide in printed documents and in online help systems? Where should you provide links or cross-references and where not?
- Kustantaja / Valmistaja Indoition Publishing E.K.
- ISBN 9783943860122
- Tuotekoodi 9783943860122
- Kirjoittajat Marc Achtelig
- Kieli Englanti
- Ilmestymispäivä 25.10.2020
- Vuosi 2020
- Tuoteryhmä Ulk talous, it, yhteiskunta
- Tuotepääryhmä Ulkomaiset kirjat
- Tuotelinja Kirjat
- Sivumäärä 174
- Avainsanat Programming - General; Technical Writing; Documentation & Technical Writing
- Kirjastoluokka COM
- Pituus (mm) 229
- Leveys (mm) 152
- Korkeus (mm) 9
- Paino (g) 240
- Tuotemuoto Pehmeäkantinen
- Tuotemuodon lisätiedot Trade pokkari (US)
Tämä tuote kuuluu tuoteryhmiin
Lue lisää tuotearvosteluista
Tuotearvostelut Suomalainen.comissa
Tutustu tuotearvostelujen käytäntöihin ja ehtoihin ennen kuin jätät arvostelun.
Suomalainen.com -verkkokaupassa on mahdollista jättää tuotearvosteluja siellä myynnissä olevista tuotteista. Tuotearvosteluja voivat jättää sekä tuotetta Suomalaisesta Kirjakaupasta ostaneet asiakkaat että muut sivuston käyttäjät. Arvostelijan nimimerkin jälkeinen teksti kertoo, onko kyseessä vahvistettu ostaja vai muu asiakas/sivuston käyttäjä.
-
Vahvistettu ostaja - Kyseinen arvostelu on jätetty käyttämällä tuotteen ostajalle lähetettyä sähköpostilinkkiä. Kyseessä on siis vahvistettu ostaja eli arvostelun jättänyt henkilö on ostanut todennetusti kyseisen tuotteen.
-
Vahvistettu suosittelija - Kyseinen arvostelu on jätetty suomalainen.com -verkkosivustolla. Arvostelijan sähköpostiosoite on vahvistettu, jotta on voitu varmistua siitä, että arvostelun on jättänyt oikea henkilö. Suomalainen.com ei kuitenkaan ole vahvistanut, että kyseinen henkilö on ostanut tuotteen.
- Ei tekstiä nimimerkin jälkeen - Kyseinen arvostelu on jätetty suomalainen.com -verkkosivustolla, mutta arvostelun jättäjän sähköpostiosoitetta ei ole vahvistettu.
Tuotearvostelussa pakollisia tietoja ovat tuotteen pistemäärä (tähdet), otsikko sekä arvosteluteksti. Jos jätät arvostelun sinulle lähetetyn sähköpostilinkin kautta, arvostelu julkaistaan käyttämällä etunimeäsi sekä sukunimen ensimmäistä kirjainta.
Jos jätät arvostelun sivustollamme, voit käyttää arvostelussa myös nimimerkkiä. Arvostelun jättämisen yhteydessä sinulta kysytään sähköpostiosoitetta, jonka avulla vahvistamme, että arvostelun on lähettänyt oikea henkilö, eikä esimerkiksi robotti. Tuotearvostelujen palveluntarjoajana toimii Yotpo. Katso Yotpon tietosuojaseloste.
Arvostelut julkaistaan tuotteen kohdalla automaattisesti ja ne tulevat esiin viiveellä. Suomalainen.com pidättää kuitenkin oikeuden poistaa kommentit, jotka sisältävät epäasiallista, herjaavaa tai halventavaa kieltä, vihapuhetta tai ovat muuten hyvän tavan vastaisia, tai joissa markkinoidaan muiden toimijoiden sivustoja tai tuotteita.
Jättämällä arvostelun annat Suomalaiselle Kirjakaupalle oikeuden käyttää kyseisiä arvosteluja omassa markkinoinnissaan (sekä painettu että digitaalinen) ilman erillistä korvausta. Arvosteluja käytetään myös analysointiin ja markkinoinnin kehittämiseen.
Tuotearvostelun jättäneiden kesken arvotaan säännöllisin väliajoin tuotepalkintoja. Tutustu arvonnan sääntöihin täällä.
Mikäli haluat poistaa jättämäsi tuotearvostelun verkkokaupastamme, pyyntö tästä tulee ohjata asiakaspalveluumme: asiakaspalvelu@suomalainen.com.
Tuotearvostelut eivät ole tarkoitettu asiakasreklamaatioiden tai tilauskyselyjen tekemiseen. Reklamaatiotapauksissa pyydämme ottamaan yhteyttä asiakaspalveluumme: asiakaspalvelu@suomalainen.com.
Jättämällä arvostelun suomalainen.com -verkkokauppaan hyväksyt yllämainitut käytännöt ja ehdot.
Lue lisää tuotearvosteluista.