Стил и стандарти в техническото писане.
Тази презентация ще ви запознае с основните стандарти за писане на техническа документация в софтуерния бранш. Защо изобщо ни трябват стандарти и какво налага прилагането на стилови правила?
2. Инструкция за експлоатация
2
Как се предава информацията?
W*F is standard?
Защо са ни стандарти и какво е Style guide?
Основни изисквания към документацията
Какво е минимализъм и topic based writing?
Какво е DITA като стандарт?
Примери за правила и как ги прилагаме
3. Как се предава информацията?
Ами зависи...
Всяка индустрия има правила
Кой е потребителят?
Какво искаме да му кажем?
Колко ще инвестираме?
3
9. Опит за дефиниция
Стандартите са документи, разработени с консенсус на основата на обединяване на резултатите от науката, технологиите и производствения опит.
Стандартите са общопризнати правила и норми и може да включват подробни технически спецификации (характеристики и изисквания към продуктите), процедури за производство, методи за изпитване и оценяване на съответствието.
Когато се прилагат стандарти, се постига по-добра ефективност при производството на продуктите и подобряване на услугите и се удовлетворяват в по-голяма степен очакванията на потребителите и клиентите. За да се повиши доверието на обществото
Общоприети правила, които
се следват от всички с цел
уеднаквяване на крайния
продукт и повишаване на
качеството.
към стандартите, е необходимо при тяхното разработване и обсъждане да участват повече заинтересувани от стандартизацията страни.
Стандартите се разработват, преработват, изменят, коригират или отменят в зависимост от новостите в развитието на науката и технологиите. За да може да се отговори на потребностите на обществото и пазара, непрекъснато расте необходимостта от
разработване на стандарти.
Стандартите са пряко свързани както с начина ни на живот, така и с условията на работа, като все по-често обхващат и услугите. Много често, дори когато не го осъзнаваме, стандартите правят живота ни по-безопасен, по-здравословен и по-лесен. Те са
средство за информация, улесняват търговията и общуването между партньорите.
Стандартите подпомагат икономическото развитие, което е в полза на цялото общество.
Последните изследвания показват, че с разработване, приемане и прилагане на стандартите в развитите европейски страни се спестяват около 15 милиарда евро за година за изследване и разработване на нови технологии за производство.
/Български институт по стандартизация/
9
10. “The good thing about standards is that
there are so many to choose from.”
Andrew Tanenbaum
10
11. Какво и трябва на една документация?
Да е лесна за използване (Usable)
• Ориентирана към целта
• Don’t tell me how it works, tell me how to use it.
• Вярна
• Be sure you are right, then go ahead.
• Пълна, но не претрупана
• A successful book is not made of what is in it, but what is left out of it – Mark Twain
11
12. Какво и трябва на една документация?
Да е лесна за разбиране (Understandable)
• Ясна
• Easy reading is damn hard writing
• Конкретна
• “… the feeling at the end of the page when you realize you don’t know what you just
read.”
• С консистентен стил
• Style is the outside of content, and content is the inside of the style.
12
13. Какво и трябва на една документация?
Лесна за намиране (Easy to find)
• Добре организирана
• ….nothing constructive can evolve from chaos except order.
• Откриваема информация
• Knowledge is of two kinds. We know a subject ourselves, or we know where we can
find information upon it.
• Визуално ефективна
• Art does not reproduce the invisible; rather it makes it visible.
13
15. Що, бе, Миме?
Потребителят знае какво да очаква
Има представа къде да търси съответната информация
Не се налага да „разгадава“ стиловете
Не се налага да чете излишна информация
Безпроблемно ползване на продукта=CA$H
15
16. Хубаво, ама много зор, бе!
16
Изисква се време за създаването
Изисква се време за осъвременяването на стандарта
Хората трябва да се обучават непрекъснато
Творчеството не е на почит?
17. Какво е минимализъм в техническата документация?
Предоставяне само на необходимото
Премахване на несъществената информация
Фокус върху осъществяване на целите на потребителя, а не
върху възможностите на продукта
Подпомагане на потребителя за извършването на задача или
решаването на проблем
Предоставяне на необходимата информация на правилното
място
17
18. Topic-based writing
Тopic – самостоятелна единица информация
Темата има заглавие и съдържание
Една тема съдържа една самостоятелна процедура, концепция
или справочна информация
18
19. DITA като стандарт за topic-based writing
DITA – Darwin Information Typing Architecture
DITA се основава на принципите на минимализма и
тематичното писане
DITA изпозлва семантични XML елементи
19
20. Видове DITA topics
Task topic – описва една процедура (как да направя това?)
Concept topic – описва как работи дадена система (как работи
това?)
Reference topic – допълнителна информация, необходима за
изпълнението на процедура (от каква допълнителна
информация може да имам нужда?)
20
22. Предимства на DITA за авторите
По-ефективно повторно използват topics
По-бързо организиране и реорганизиране на съдържанието
По-лесно споделяне и разпределяне на работа по отделните
теми
22
23. Предимства на DITA за потребителите
По-бързо намират на необходимата информация
По-ефективно постигат целите си
Четат само необходимата им информация
23
24. Предимства на DITA за компанията
Намаляване на разходите за локализация и публикуване
24
26. Use Quick Filters
You can use quick filters to find an object or a set of objects in your vSphere Web Client inventory that fit certain criteria.
Quick filters are available in the list views, which appear in the Objects tab of an inventory list, on the Related Objects tab, and in search results.
For example, you can use the quick filter options for virtual machines to find all virtual machines in your vSphere inventory that are powered on but do not have VMware
Tools running.
Procedure
1 From the vSphere Web Client, open a list view.
You can access list views of objects from the Inventory Lists, the Related Objects tab, and the search results.
2 Click Show and hide quick filters (
) next to the filter box, and select from the available options.
A list of inventory objects that meet your selection criteria is displayed.
What to do next
To clear the filtered list of vSphere inventory objects, deselect the filter criteria or click Clear next to the filter group name.
Subtopics
Quick Filters Available for vSphere Objects
26
28. Before writing, think what you want to say?
What is your audience?
What purpose does your document serve?
• Deciding a particular issue
• Giving conceptual information about the product
• Guiding the user through the steps to complete a task
Answer the 5 W's & 1H
•
•
•
•
•
•
28
Who
What
Where
When
Why
How
•
•
•
•
•
•
Кой
Какво
Къде
Кога
Защо
Как
29. VMware Style Guide
Technical writers at VMware must apply the
VMware Style guidelines for grammar, word usage,
and tone when authoring technical content.
29
30. VMware Style Guide
Keep it short.
We strongly recommend that you back up your database before beginning the
upgrade so that if the upgrade fails for any reason or if you cancel out of the database
upgrade operation before it is finished, you will be able to recover your data.
(One sentence, 44 words)
Back up your database before beginning the upgrade. If the database upgrade fails
or you cancel the operation, you can then recover your data.
(Two sentences, 24 words)
30
31. VMware Style Guide
Reveal who performs the action.
Until a browser is added to the list, its use with the product is not supported.
Until VMware adds a browser name to the list, you cannot rely on product support
for that browser.
31
32. VMware Style Guide
Address the user as "you.“
You have chosen to shutdown host 10.112.2.165.
If you want to make your alternate email address the new primary address, you'll
first need to delete your alternate email address from the account.
32
33. VMware Style Guide
Use present simple tense
The Web pages have been uploaded during the installation.
The Web pages are uploaded during the installation.
33
34. VMware Style Guide
Use Active voice
If there is a compatibility issue, the problem is displayed in the Compatibility panel.
Any compatibility problem appears in the Compatibility panel.
34
35. VMware Style Guide
Avoid stacking nouns and modifiers
This section contains the URL of the toolbar frame style sheet.
This section contains the URL of the style sheet that is used for the toolbar frame.
35
36. VMware Style Guide
Be specific.
Downloading the ZIP file might take a long time.
Downloading the ZIP file might take a few minutes.
Duplicate Role Name.
The role name is already in use. You must provide a unique role name.
36
37. VMware Style Guide
Word choice
Do not use
Replace with
able to, will be able to
can
as well as
and
backend
back end
since
because
slice and dice
Jargon. Do not use.
shut down
shutdown
terminate
Replace with "exit the program," "end a
session," "close," or "stop."
37
40. QUIZ!
1. Select the most appropriate instruction for technical
documentation.
By typing run, you can run the process.
Type run.
Enter the run command.
Invoke the command run.
To run the process, type run.
Source: http://mrwhatis.net/minimalism-in-writing.html
Filename: minimalist_writing_v6.ppt
40
41. QUIZ!
1. Select the most appropriate instruction for technical
documentation.
By typing run, you can run the process.
Type run.
Enter the run command.
Invoke the command run.
To run the process, type run.
Source: http://mrwhatis.net/minimalism-in-writing.html
Filename: minimalist_writing_v6.ppt
41
42. QUIZ!
2. Select the phrase that is a best practice in technical writing.
The integer values should match exactly in order to complete the operation.
The integer values must match.
The integer values must have an accurate match.
Making the integer values match exactly is a mandatory operation.
Source: http://mrwhatis.net/minimalism-in-writing.html
Filename: minimalist_writing_v6.ppt
42
43. QUIZ!
2. Select the phrase that is a best practice in technical writing.
The integer values should match exactly in order to complete the operation.
The integer values must match.
The integer values must have an accurate match.
Making the integer values match exactly is a mandatory operation.
Source: http://mrwhatis.net/minimalism-in-writing.html
Filename: minimalist_writing_v6.ppt
43
44. QUIZ!
3. Which of these will make a meaningful and succinct topic title?
Introduction to the Change Logs feature in Communications Manager.
Using the Change Logs feature
Change Logs
About the Change Logs feature in Communications Manager
Source: http://mrwhatis.net/minimalism-in-writing.html
Filename: minimalist_writing_v6.ppt
44
45. QUIZ!
3. Which of these will make a meaningful and brief topic title?
Introduction to the Change Logs feature in Communications Manager.
Using the Change Logs feature
Change Logs
About the Change Logs feature in Communications Manager
Source: http://mrwhatis.net/minimalism-in-writing.html
Filename: minimalist_writing_v6.ppt
45
46. QUIZ!
4. Select the most appropriate instruction for technical
documentation.
The text can be modified by you.
Modify the text.
The text can be modified in String field.
In the required manner, modify the text.
Modify the text in the String field.
Source: http://mrwhatis.net/minimalism-in-writing.html
Filename: minimalist_writing_v6.ppt
46
47. QUIZ!
4. Select the most appropriate instruction for technical
documentation.
The text can be modified by you.
Modify the text.
The text can be modified in String field.
In the required manner, modify the text.
Modify the text in the String field.
Source: http://mrwhatis.net/minimalism-in-writing.html
Filename: minimalist_writing_v6.ppt
47
49. Инcтpyĸции зa paбoтa c пoжapoгacитeл
Bъпpeĸи чe имa мнoгo paзлични видoвe пoжapoгacитeли, ycтpoйcтвoтo нa
вcичĸи ce cъcтoи oт няĸoлĸo ocнoвни ĸoмпoнeнтa - в мeтaлнa бyтилĸa имa
гacитeлнo вeщecтвo, изтлacĸвaщ гaз, ĸoйтo пpидвижвa тoвa вeщecтвo, вeнтил
и пpeдпaзeн ĸлaпaн, мaнoмeтъp (пpи няĸoи пoжapoгacитeли нямa мaнoмeтъp),
шлaнг.
Дoбpe e пpeди дa изпoлзвaтe пoжapoгacитeл дa пpoчeтeтe yĸaзaниятa нa
бyтилĸaтa, aĸo нe e твъpдe ĸъcнo зa тoвa. Cъщo тaĸa пpи пoжap, aĸo нe знaeтe
или нe cтe cигypни ĸaĸви cyбcтaнции гopят и имa oпacнocт oт eĸcплoзия
изчaĸaйтe нaмecaтa нa пpoтивoпoжapнитe opгaни.
Нa ĸpaтĸo изпoлзвaнeтo нa пoжapoгacитeли ce cвeждa дo 3 пpocти дeйcтвия.
Започва се като трябва да се издърпа пpeдпaзитeля нa пoжapoгacитeля - тoвa
щe ocвoбoди зaĸлючвaщия мexaнизъм, зa дa мoжeтe дa гo изпoлзвaтe. След
това нacoчeтe мapĸyчa ĸъм ocнoвaтa нa oгъня, a нe ĸъм caмитe плaмъци. Toвa
e мнoгo вaжнo, зa дa пoтyшитe пoжapa. Haтиcнeтe cпycъĸa (пpи пpaxoв
пoжapoгacитeл бeз мaнoмeтъp, cпycъĸaт ce нaтиcĸa двa пъти). Πpъcĸaйтe oт
eдиния дo дpyгия ĸpaй, пpeминaвaйĸи пo цялaтa плoщ нa oгъня, дoĸaтo тoй нe
зaпoчнe дa нaмaлявa. Πpoчeтeтe инcтpyĸциитe нa пoжapoгacитeля, зaщoтo
paзличнитe пoжapoгacитeли имaт paзличнo paзcтoяниe (paбoтнo paзcтoяниe),
oт ĸoeтo тpябвa дa ce oпepиpa c тяx.
49
50. Инcтpyĸции зa paбoтa c пoжapoгacитeл
Bъпpeĸи чe имa мнoгo paзлични видoвe пoжapoгacитeли, ycтpoйcтвoтo нa вcичĸи
ce cъcтoи oт няĸoлĸo ocнoвни ĸoмпoнeнтa - в мeтaлнa бyтилĸa имa гacитeлнo
вeщecтвo, изтлacĸвaщ гaз, ĸoйтo пpидвижвa тoвa вeщecтвo, вeнтил и пpeдпaзeн
ĸлaпaн, мaнoмeтъp (пpи няĸoи пoжapoгacитeли нямa мaнoмeтъp), шлaнг. (40
думи)
Дoбpe e пpeди дa изпoлзвaтe пoжapoгacитeл дa пpoчeтeтe yĸaзaниятa нa
бyтилĸaтa, aĸo нe e твъpдe ĸъcнo зa тoвa. Cъщo тaĸa пpи пoжap, aĸo нe знaeтe или
нe cтe cигypни ĸaĸви cyбcтaнции гopят и имa oпacнocт oт eĸcплoзия изчaĸaйтe
нaмecaтa нa пpoтивoпoжapнитe opгaни. (42 думи)
Нa ĸpaтĸo изпoлзвaнeтo нa пoжapoгacитeли ce cвeждa дo 3 пpocти дeйcтвия.
Започва се като трябва да се издърпа пpeдпaзитeля нa пoжapoгacитeля - тoвa щe
ocвoбoди зaĸлючвaщия мexaнизъм, зa дa мoжeтe дa гo изпoлзвaтe. След това
нacoчeтe мapĸyчa ĸъм ocнoвaтa нa oгъня, a нe ĸъм caмитe плaмъци. Toвa e мнoгo
вaжнo, зa дa пoтyшитe пoжapa. Застанете така, че изходът от помещението
с пожара да е зад вас, а пожарът да е пред вас.Haтиcнeтe дръжката за
да освободите съдържанието на пожарогасителя (пpи пpaxoв
пoжapoгacитeл бeз мaнoмeтъp, cпycъĸaт ce нaтиcĸa двa пъти). Πpъcĸaйтe oт
eдиния дo дpyгия ĸpaй, пpeминaвaйĸи пo цялaтa плoщ нa oгъня, дoĸaтo тoй нe
зaпoчнe дa нaмaлявa.
50
Πpoчeтeтe инcтpyĸциитe нa пoжapoгacитeля, зaщoтo paзличнитe пoжapoгacитeли
имaт paзличнo paзcтoяниe (paбoтнo paзcтoяниe), oт ĸoeтo тpябвa дa ce oпepиpa c
51. Инcтpyĸции зa paбoтa c пoжapoгacитeл
При закупуване на пoжapoгacитeл, запознайте се с yĸaзaниятa за употреба.
авни елементи на пожарогасител
Пpeдпaзител
Шланг
Манометър
Дръжка
Изтлacĸвaщ гaз
Гacитeлнo вeщecтвo
Мeтaлнa бyтилĸa
Пpи възникване на пoжap, aĸo нe знaeтe ĸaĸви cyбcтaнции гopят и дали могат да причинят
eĸcплoзия, напуснете мястото на пожара по най-бърз начин и уведомете пpoтивoпoжapнитe
opгaни.
Помогнете на всеки намиращ се в опасност, без да рискувате вашето здраве и живот.
Позвънете на тел.112
Как да използвате пожарогасител, в случай на пожар:
1. Издърпайте предпазителя на пожарогасителя.
2. Насочете струята на пожарогасителя към основата на пламъка. Застанете
така, че изходът от помещението с пожара да е зад вас, а пожарът да е пред
вас.
Натиснете дръжката, за да
съдържанието на пожарогасителя.
3.
51
освободите
Можете ли да изброите продуктите, за които се пише потребителска документация?Всяка индустрия, която произвежда някакъв продукт, предоставя информация за него на своите клиенти. В зависимост от особеностите на продуктите, информацията за потребителите и начинът, по който е представена, се различава.
Например, храните имат текстово описание на съдържанието, някои имат начин на приготвяне, всички имат начин на съхранение.
За телевизорите има описание на външния вид в графика, мерки за безопасност и инструкции за експлоатация и т.н.
Тук пише, че това е на български език, което ме кара да мисля, че би трябвало да го разбера. Понеже не се вижда много добре, че ви прочета част от този документ. Това е резултатът от липсата на стандарт за потребителската документация в България.
Това е дефиницията за стандарт, която може да немерите на сайта на Българския институт по стандартизация. Не бойте се! Няма да я четем. Това, между другото, е чудесен пример за това как не трябва да се поднася информация в презентациите. Това е много съкратена и опростена версия на дефиницията за стандарт, която за днес ще свърши работа. Ако искате да прочетете пълната дефиниция и списък на ползите от стандартизацията, посетете сайта на Българския институт по стандартизация: http://www.bds-bg.org/bg/button_23.htmlВ IT индустрията също има определена структура на потребителската документация, която обаче варира между различните компании.Дори вътре в едно предприятие, различните отдели се явяват и производители, и потребители на информация за другите отдели.
Стандарт за писане, който нашата компания дефинира, за да постигне съответствие с изискванията към документацията.
Според вас, какво налага нуждата от стандарти?Както вече казахме, обменът на информация се осъществява чрез различни средства: текст, видео, графика, организирани по всевъзможни начини. Това често води до объркване и трудност, дори невъзможност да се намери необходимата информация. Това налага необходимостта от въвеждане на стандарти.
Според вас, до какви трудности води въвеждането на стандарт за писане?Въпреки трудностите, въвежднето на стандарти в документацията е дкоазало своите предимства. Ние във ВМУ следваме принципите на минимализма и топк-бейздрайтинг, за които сега ще ви разкаже колегата Йордан Георгиев.
Минимализмът е принцип при представянето на информация – дава се само точната и необходима информация на потребителя за изпълнението на дадена задача/процедура или за разбирането на определена концепция. Тази информация трябва да бъде предоставена точно там, където потребителят има нужда от нея.За да приложим успешно принципите на минимализма трябва да разбираме продукта много добре, да получаваме и вземаме предвид обратната връзка от потребителите и да премахнем несъщественото съдържание, така че информацията, която предоставяме да бъде фокусирана върху осъществяване на цели и изпълнение на задачи. Минималистичната документация трябва да описва само един начин за извършване на дадена задача (по колко начина може да принтираме файл?). Като премахнем несъщественото придаваме по-голяма стойност на съдържанието, което остава, повишаваме качеството на информацията и гарантираме краткост и яснота.Принципи на минималистичното писане (обобщение):Фокус върху действия, а не знанияПредоставяне на информация в контекста на работната среда на потребителяФокус върху решаването на проблемиПредоставяне на лесен и бърз достъп до информацияКакво не е минимализъм?Писането на опростен технически езикИзползването на малко думи Използването на номерирани или неномерирани списъци от стъпкиПремахването на случайно съдържание или страници
Тематичното писане (topic-based writing)е резултат от прилагането на принципите на минимализма в контекста на създаването на техническа документация. Topic-based writing е метод за писане на техническа документация, при който съдържанието е разделено на кратки, самостоятелни отрязъци (теми - topics).Всяка тема (topic) има заглавие и съдържа само една самостоятелна информационна единица: това може да бъде процедура (как да инсталираме софтуерния продукт), концептуално описание (как работи системата), или справочна информация (списък с команди)The clearest analogy I’ve found to explain topic-based writing that of links in a chain. Each link is a topic. Each link makes the entire chain stronger, but each link could be replaced with another, equally valid, equally strong link. Each link, although connected to other links, does not completely depend on the others. They are connected but they are still independent pieces that make up the stronger, and more versatile, whole.Unlike the limitations of an actual, physical chain where each link can only connect to two others, content delivered online has no such limitation. Each topic is only a click away from any and all other topics. This means we can expand the analogy to a chain-link fence or even a web of chain-link fences.
DITA е създадена като стандарт от IBMпрез 1999. През 2004 се прехвърля към OASIS (Organization for the Advancement of Structured Information Standards), която продължава да развива DITA до днес. DITA дава начин да приложим принципите на минимализма и topic based writing и да ги използваме за организиране, структуриране, управление и публикуване на техническа информация.Техническата документация се създава в DITA под формата на теми (topics), като всяка тема е отделен XML файл.
Има три основни вида теми в DITA:Tasks: Обяснява на потребителите как да постигнат дадена цел, например инсталиране на софтуерен продукт; дава подробни стъпки, обикновено под формата на номериран списък; казва какъв е резултата от изпълнението на процедурата. Concepts: Дава на потребителя концептуално обяснение за принципите на работа на системата, как отделните компоненти си взаимодействат; често включва графики и диаграмиReferences: допълнителна справочна информация под формата на таблици, например таблица с команди и командни опции.Тези видове теми се организират в DITA maps (карти): отделен файл, който съдържа всички теми и реда на представянето им в крайната публикация.
Използването на DITA дава предимства на всички: Авторите на документацията могат да използват повторно дадена тема в различни публикации; могат лесно да организират съдържанието само чрез разместване на реда на темите в DITA картата. Работата може да бъде разпределена много по-лесно като всеки автор има само определени теми по които работи.
Използването на DITA дава предимства на всички: Потребителите на документация – позволява им по-бързо да намерят необходимата им информация, понеже тя е разделена на отделни, ясно формулирани и наименувани теми. Това води до по-ефективно постигане на целите на потребителите – могат много по-бързо да започнат да използват продукта; не губят време в четене на излишна информация
Използването на DITA дава предимства на всички: Компанията – по-малко разходи за локализация и публикуване на документацията. От един набор изходни файлове се генерират множество крайни формати като HTML, PDF, epub.
Who – кой е вършителя на действиетоWhat - Identify the characters in the reading and make a list of them.connecting lines between the events or actions to show the relationship between them.connecting lines between the characters and the events as you describe to yourself the relationship between them.Where - Identify all the places in the reading and make a list of them.Why - causes to effects on the characters, events, places.When – дали се случва в определени случаи, винаги ли, колко време отнемаHow – как се случва действието, има ли връзка между него и други събития.
Remove unnecessary words.
Избягване на неяснотаНе оставяме на читателя да интерпретира кой е вършителя на действието, или от кой произтича действието.
Write text that is user-focused.
present tense are easier to translate and are more direct because the performer and the action are more obvious.
Passive voice hides who or what is performing the action and the cause and effect.
Readability suffers when nouns that are normally separate are grouped together or when multiple modifiers are used to describe a noun.
Give users the information they need to resolve issues.
Примери за думи, които не са подходящи за техническа документация, или не са изписани правилно