????????? ?????????, SmartLabs

1
??????????? ???????????? ? ???????????????? ??

• ????????? ?????????, SmartLabs
• ???-???

2
????? ??? ????

• ?? ???????? ????????????? ? ????? ????????????
  ??????????? ???????????? (technical
  communication, TC).
• ?? ????????????? ? ???????????? ??????????
  ???????????????? (documentation tools)
  ??????????? ??????.
• ?? ??????? ?????? ???????? (best practices)
  ???????????????? ? ????????? ??????, ???????
  ????? ???? ??????? ??? ??????.

3
??????????? ????????????

• ????? I

4
???????? ???????????? ?????????? ??? ?????
????????????

• ???????? ??????
• ?????
• ????? ? ??
• ??????????? ???????????????? ????????? (GUI)
• ????????

5
?? ?????????? ??? ?????? ????????

• ????????????, ??????????, ????? ??????????
  ???????????????? ? ??????? ??????????? ??????? ?
  ????????.
• ???? ?????????? ??? ?????? ???????? ? ?????????
  ?????? ????????????, ? ???????????? ?????.

6
??? ????????????, ?? ?????, ????? ????????? ????
????????
???????? (Usability) ???? ?? ????????
????????????? ???????? ? ???????????? ??
?????????? ISO 9126.
7

• ????????? ??? ?????? ?????? ? ????? ???????????
  ????????????, ????? ?????? ????????? ????????? ??
  ??????? ???????????, ????? ??????? ????????? ?
  ?????????? ? ??? ???????? ? ??????????????.

8
??????????? ???????????? ??? ????????? ???????

• ?? ?????? ???????? - ???????? ?????????? ???????
  ? ??????????? ????????????????? ????????????
• ?? ?????? ??????? ?????????? ?????????????? ?
  ???????
• ??? ???? ???????? ??????? ???????????? ??? Soft
  Skills

9
??? ????? ??????????? ??????????????

• ????????? (designers)
• ??????????? ???????? (technical writers)
• ????????? (editors)
• ???????????? ???????????????? ??????????? ?
  ??????????? ?? ?????????? (UI developers, UI
  usability experts)
• ???????????? ????????? ?????? ? ??????? ???????
  (training course developers)
• ??????????? ?? ?????????????? ???????????
  (information architects)
• ???????????? ?? ????????, ???????????,
  ??????????????????? ???????????????? ???????????
  (translation, localization specialists)
• ??????????? ??????????? ????????? (Support
  engineers)
• ??????????? ?? ???-?????????? ? ??????? (copy
  writers)

10
(No Transcript)
11
Society for Technical Communication (STC)

• ???? ?? ?????????? ????????????? ?????????? ?
  ??????? TC
• ??????-??????? ?????
• ??????????
• ??????? ? ????? ??????

12
Lynda.com

• ????? 900 ?????? ? 57 ????? ????????????
  ??????????? ?? ???????????? ? ????????
• Adobe Photoshop, Illustrator, InDesign
• Adobe Captivate
• Corel Draw
• Camtasia Studio
• AutoCAD

13
???????????

• ??????????? Technical Communication Summit
  www.summit.stc.org
• ???????? ????? ???????? ??????????? ????????????,
  ??????????? ?????? TCWorld, ??????????? TC World
  www.tekom.de
• ????????????? ??????????? AODC (Online
  Documentation and Content Conference)
  www.aodc.com.au
• ??????????? Intelligent Content
  www.rockley.com/IC2011
• ?????????? ???????? ?? ???????????? ??????
  ????? ???????????? ????? www.mashstream.com,
  www.idratherbewriting.com

14
??????? ???????!
15
???????????????? ??

• ????? II

16
???????????????? ?? ???????????? ? ??????????
????????????? ???????? ? ??????? ???????????
?????? ? ????? ??.
17
???? ??????????
18
????????? ?????????

• ??????????? ??????? (??), ??? software
  requirements specification (SRS)
• ???? ???????
• ????????? ? ???????? ?????????
• UML-????????? ????????????? ???????

19
??????????? ?????????? ????????? ????????????
???????? ?????????? (???????) ?????????? (???????)
??????????? ??????? IBM Doors IBM Requisite Pro AutomatedQA Software Planner Borland Caliber RM
???? ??????? Microsoft Project Oracle Primavera Enterprise
UML-????????? IBM Rational Rose Altova UModel Sparx Enterprise Architect
????????? ? ???????? ????????? (Acceptance Tests Specification) Atlassian JIRA Microsoft Team Foundation System
20
???????????????? ?????????

• ??????????? ? ?????????? (User Guide, User
  Manual)
• ??????? ?? ???????? ???????? (Reference)
• ???????? ????????? ?????? ???????? (Release
  Notes)
• ?????? ?? ??????? (Frequently Asked Questions)
• ??????? ????????? ??????? (Troubleshooting)
• ?????? How-To
• ?????? ? ?????? ????????? (Best Practices)
• ???????????-???? (screencasts, podcasts)

21
??????????? ?????????

• ???????????? ????????????, ?????? (datasheet)
• ???????????? ?????????? (RFC)
• ?????????? ??????????? (coding conventions)

22
???????????? ????

• ???????? ??????????? ??????????? (API)
• ???????? ???????, ?? ??????? ? ???????
• ???????? ??????????????????? ????????????
  ?????????
• ??????????? ????? ???? ??????????
• ??????? JavaDoc, Doxygen

23
???????? ?????????? ???????? ??????? ??????????
?????????? (J.T. Hackos)

• ???????????? ?????????? (Information Planning,
  10)
• ?????????????? (Information Design, 20)
• ?????????? (Information Development, 50)
• ???????????? (Production,20)
• ?????????? (Evaluation, ????? 1)

24
?????? ?????????? ????????????
25
??? ????? ??? ?????????? ?????????????
26
Information Process Maturity Model (IPMM)

• Organizational structure (???????????????
  ?????????)
• quality assurance (??????????? ????????)
• planning (????????????)
• estimating (??????)
• scheduling (??????????? ? ?????????? ???????)
• tracking (???????????? ??????? ?????, ?????,
  ????????)
• hiring and training (???? ? ????????)
• information design (?????????????? ??????????)
• cost control (???????? ????????)
• quality management (?????????? ?????????)
• collaboration (?????????? ??????)

JoAnn T. Hackos
27
????????? ???????????? (??)

• ?????????? ????????? ???????????? ?? ????????
  ????????????? ??????????
• ???? ? ??? 9001-2008. ??????? ???????????
  ????????
• ???? ? ???/??? 12207-99. ??????????????
  ??????????. ???????? ?????????? ????? ???????????
  ???????
• .
• ??????????? ?????????? ?????????
• ???? ? ???/??? 15910-2002. ??????????????
  ??????????. ??????? ???????? ????????????
  ???????????? ???????????? ????????
• ???? ? ???/??? ?? 9294-93. ??????????????
  ??????????. ??????????? ?? ??????????
  ????????????????? ???????????? ???????????
• ???? ? ??? 9127-94. ??????? ?????????
  ??????????. ???????????? ???????????? ?
  ?????????? ?? ???????? ??? ???????????????
  ??????????? ???????
• ??????????, ?? ??? ??? ?????????????? ?????????
• GOST 19.?? - - ????? ????? ???? (?????? ???????
  ??????????? ????????????). ??? ????????? 80-90-?
  ?????. ??? ???????? ?????????? ? ??????????
  ?????????? ???????????? ? ????????????, ????
  ??????????, ???? ??????, ???????????? ??
  ??????????? ???????.
• GOST 34.?? ?????????????????? ???????. ????????
  ?????????? ?? ?????????????????? ???????.
• ????? ?????????? ???????? ?? ???? ????? - ????
  34.602-89 ??????????? ??????? ?? ????????
  ?????????????????? ???????. ??? ?????????? ?
  ?????????? ?? ?? ??, ??????? ????? ???????????
  ??? ?????????????? ??????, ??????????????? ???
  ??????????????? ???????????, ?????????? ? ?.?.

28
????????? - ?????????????

• ????????????? ????????? ???????????? ?? ????????
  ?????????? ? ??????? ?????????? ??
• ISO 9000. Quality Management
• ISO/IEC 122072008. Information technologies.
  Software life cycle processes.
• ISO/IEC 152882008 - Systems and software
  engineering-System life cycle processes. ??
  ???????????? ISO/IEC 122072008.
• ????????????? ????????? ? ???????????? ? ???????
  ????????????????
• ISO/IEC 152892006 - Content of systems and
  software life cycle process information products
  (Documentation).
•  ISO/IEC 26513 - Systems and software engineering
  - Requirements for testers and reviewers of user
  documentation
• ISO/IEC 265142008 - Requirements for designers
  and developers of user documentation. It provides
  requirements for the design and development of
  software user documentation as part of the life
  cycle processes. It defines the documentation
  process from the viewpoint of the documentation
  developer.

29
??????? ??????? ?????????

• ?????????? ?????????? ? ?????????? ???????? (?
  Word, CHM) ?? ??????? ?????????
• ?????????? ?????? ?????? ???????
• ???????????? ????????????? ????? ? ??? ?? ??????
  ???????? (content re-use)
• ?????? ??????? ???????? ??? ???? ????? ????????
  ????????????

30
??? ??? ????????????
31
?????????????? ???????????

• OASIS (Organization for Advancement of Structured
  Information Standards) ????????????? ?
  ???????????? ????? ?????????? ??? ????????
  ?????????????? ???????????.
• DocBook (1991, HAL Computer Systems, ORelly)
• DITA (2001, IBM)

32
DocBook

• ??????????-??????????????? ??????? ??????,
  ?????????, ?????, ?????
• ???????? ??? ?????????? ????????? ????? ?????????
  ? ???????????????? ??????????
• ??????? ????????, ?? ????????? ? DITA

33
DocBook
34
DITA (Darwin Information Typing Architecture)

• ????????????? ?????? ?????????????? ?????
• ????????? ????????? ?? ?????? ?? ??????
  Task, Question, Workaround
• ??????????? ?????????? ??????????? ?????,
  ????????? ????????????
• ??????????? ???????? ???????? ???????????
• ??? ??????? ???????, ??????? ????????? ? ?????????

35
DITA
36
??????? ????????????????

• ??????????????? ????? ?????????? ?????????? (help
  authoring tools)
• ??????????? CMS - Wiki-???????
• XML CMS, ?????????????? ???????? DITA

37
Help Authoring Tools

• Author-it
• Adobe RoboHelp
• MadCap Flare
• HelpManual
• EMC Documentum
• Dr. Explain
• MindTouch

38
Wiki-???????

• MediaWiki
• TWiki
• PmWiki
• DokuWiki
• Confluence

39
XML CMS ??? ?????? ? DITA

• Horizon
• XDocs
• X-Hive/Docato
• TEXTML Server (DITA CMS Framework)
• Contenta
• SiberSafe

40
????? ??????? ????????

• ??????? ????? ?????????? Wiki
• ?? ??????????? ????????? ????????? Wiki, Help
  authoring tools, XML CMS
• Wiki ?????????? ? ????????? ? ??????? ?????????.
• Help authoring tools ??????????? ? ??????? ?
  ??????? ???????????? NASA, NEC, Gartner.
• XML CMS ???????????? ? Adobe, Boeing, Nokia, IBM,
  Oracle ? ??.

41
??????? ???????????????? ??????????

• ???????? ????????? ? ??????? PDF, MS Word
• ??????-??????? (Wiki, ?????)
• ??????-?????????? ??????? (WebHelp)
• ??????????? ??????? (HTML Help, MS Help 2,
  JavaHelp, FlashHelp)
• ??????????? ????? (ePub, FB2)

42
????? ????????? ? ??????????
The Chicago Manual of Style

• APA Style (?????????? ??????????, ?????????
  ???????, ???????????)
• IEEE Style (??? ?????????? ?????????? IEEE)
• MLA Style (?????????? ??????? ??????)
• ESL Standards (?????????? ?????????? ???
  ?????????????? ????????)
• O'Relly Stylesheet and Word List (??????????
  ???????? ???????, ??? ??????????? ????????????
  ????????????? O'Relly, ??????? ?????????
  ??????????? ??????????)

43
?????.

• ??????? ?????? ???????? ??????? ???????? ????.

44
??? ???????? ??????? ???????????? ?? ???????

• ?????????????? ?? ??????, ??????? ????? ?????????
  ????????????, ? ?? ?? ???? ????????.
• ?????????????? ?? ?????????? ????? ?????????????.
• ??????????? ??????? ???????? ?????????.
• ????????? ?????? ?? ??????????, ???????
  ????????????? ????? ????????????.
• ?????????? ???????????? ??????? ???????????
  ??????? ????? ?? ?????????.
• ??????????? ????? ???????? ??? ????????
  ??????????? ?? ?????????? ????????????.

45
? ??? ?? ?????????..
46

• ?????? ???? (Edward Tufte) ????????? ?????????
  ????? ? ??????????? ?? ????????? ?????????
  ????????? ???? ??? ???, ??? ?? ????????? ?????
  ????? ?????? ?? ?????? ??????.

47
??????????

• ??????????? ???????????? (TC) ?????????? ?
  ??????? ????????????? ??????? ??????,
  ???????????? ?????????????? ????????? ?????????
  ?? ????????? ? ???????????? ???????? ??
  ??????????? ?? ?????????????? ??????????? ?
  ???????????? ????????????????? ??????????.
• ???????????????? ???? ?? ?????? ???????? TC,
  ??????? ?????????? ?????????????? ????????? ?
  ????????????? ????????, ??????? ??????????
  ?????????? ?????????????? ??????????? ?
  ??????????? ?????? ????????????.

48
?????? ?????? - TC

• Society for Technical Communication www.stc.org
• Lynda.com www.lynda.com
• Technical Writing, Id Rather Be Writing
  www.idratherbewriting.com
• ????? ? ?????? ??????? ????? (Edward Tufte)
  www.edwardtufte.com

49
?????? ?????? - ????????????????

• ????? ?? ??????? ?????
• ?????? ?.?. ???????????????? ??????? ???????????
  ???????.
• ?.?. ???????????. ?????????? ????????????
  ???????????? ???????????? ????????. ???????? ?
  ????? ?????????.
• ?. ????????. ?????????? ??????????? ????????????.
  ??????????? ??? ??????????? ????????? ?
  ????????????? ??.
• ??????? ??????????? ? ?????????
• The Chicago Manual of Style.
• IEEE Style. www.standards.ieee.org/guides/style
  (???????????? ??? ?????????? ??????? ??????????,
  ? ????????? ?? ??????????? ?????????)
• JoAnn T. Hackos. Information Development
  Managing Your Documentation Projects, Portfolio,
  and People.
• DITA Newsletter www.ditanewsletter.com
• Organization for the Advancement of Structured
  Information Standards (OASIS) www.oasis-open.org
• Software Engineering Process Technology (SEPT)
  www.12207.com

50
??????? ?? ????????!

• E-mail estepalina_at_gmail.com
• ???? www.katyastep.wordpress.com

51
????????