Technical Documentation Copy and Paste Kit

Апісанне

Не, гэты камплект не будзе пісаць для вас ваша наступнае кіраўніцтва карыстальніка або вашу наступную сістэму даведачнай дапамогі. Тым не менш, гэты камплект дапаможа вам напісаць тэхнічную дакументацыю з меншымі намаганнямі, і гэта дапаможа вам стварыць зручныя, высакаякасныя дакументы.

Камплект дае вам менавіта тое, чаго не дае ваш тэкставы рэдактар, інструмент стварэння даведкі або сістэма кіравання кантэнтам: ноў-хаў і рэкамендацыі для стварэння высакаякаснай дапамогі карыстальнікам.

Аднак, у адрозненне ад многіх падручнікаў па тэхнічным напісанні, камплект не дае доўгіх тэарэтычных распрацовак. У ім дадзены практычныя рэкамендацыі і прыклады, якія вы можаце лёгка запомніць і адаптаваць да сваёй працы.

У камплект уваходзіць:

* візуальны дызайн (макет) вашых дакументаў

* структура вашых дакументаў

* як напісаць простыя інструкцыі, зразумелыя кожнаму карыстальніку

Вам не трэба быць дызайнерам, каб рэалізаваць рэкамендацыі па дызайне, і вам не трэба быць лінгвістам, каб зразумець правілы напісання. Усе рэкамендацыі суправаджаюцца яркімі прыкладамі.

Камплект напісаны на зразумелай, простай англійскай мове, якую вы лёгка разумееце, нават калі вы валодаеце англійскай як другой мовай. Амаль усе правілы з'яўляюцца ўніверсальнымі, так што вы таксама можаце выкарыстоўваць набор, калі вы пішаце на іншых мовах, акрамя англійскай.

У Plus Edition гэтага набору вы і ваша каманда можаце дадаць свае ўласныя канвенцыі і правілы для канкрэтнай кампаніі. Атрымаць прафесійнае, але індывідуальнае інтэрактыўнае кіраўніцтва па стылі напісання ніколі не было прасцей. Вы вольныя кантраляваць, хто можа рэдагаваць правілы: толькі вы, толькі выбраныя члены каманды або ўсе.