Писането на софтуерна documentация играе неразделна роля в работата на програмиста. Както се казва, ако не е documentиран, значи не съществува и в повечето случаи documentирането на вашия code по подходящ начин е също толкова важно, колкото действителното му писане. „Без meaning колко прекрасна е вашата библиотека и колко интелигентен е нейният дизайн, ако вие сте единственият, който я разбира, няма да е от полза. Документацията означава не само автоматично генерирани препратки към API, но и анотирани примери и задълбочени ръководства. Имате нужда и от трите, за да сте сигурни, че вашата библиотека може лесно да бъде възприета,” каза Никълъс Закас, известен фронтенд инженер и автор на книги. Ето защо днес решихме да разгледаме някои от най-добрите и най-често използвани инструменти за софтуерна documentация и техническо писане.
Помощни инструменти за създаване
Помогнете на инструментите за създаване да играят основна роля в софтуерната documentация и техническото писане, тъй като те улесняват много по-лесно проектирането, писането, публикуването и поддържането на софтуерна documentация. Те ви позволяват да намалите времето и усorята, необходими при създаването на всяHowви помощни материали Howто за крайните потребители, така и за други програмисти/служители.
MadCap Flare е един от най-популярните инструменти за създаване на помощ благодарение на богатата си селекция от функции, които ви позволяват да правите много повече от просто писане на помощна documentация. MadCap Flare е проектиран за усъвършенствано базирано на теми авторство, публикуване с един източник и управление на съдържанието. Позволява ви да създавате уебсайтове за помощ и поддръжка на клиенти, често задавани въпроси, бази знания, центрове за онлайн обучение, ръководства, ръководства за правила и proceduresи и др. Функциите на MadCap Flare улесняват повторното използване на едно и също съдържание в множество канали и бързото му публикуване в различни платформи.
Document360 е друга широко използвана уеб платформа, която ви позволява да създавате, публикувате и актуализирате всяHowви бази от знания и помощни материали. Освен това има многопрофилна функционалност, включително прост текстов редактор Markdown, Category Manager за изграждане на структурата на базата от знания, функции за персонализиране на целевата page, връщане назад към versionта, архивиране и възстановяване, гъвкави роли и настройка на разрешенията и т.н.
Adobe RoboHelp е друг мощен алтернативен инструмент за създаване на помощ, който предлага малко по-различен избор от функции в сравнение с MadCap Flare и Document360. По-специално, Adobe RoboHelp предлага лесно многоформатно публикуване, което ви позволява да публикувате съдържание в широка гама от популярни изходни формати, включително Frameless Responsive HTML5, PDF, Microsoft Help (CHM) и дори по-рядко срещани формати като EPUB 3, KF8 и MOBI.
Основното предимство на Help+Manual е неговият прост интерфейс, който го прави много достъпен и лесен за използване, заедно с пълната функционалност на WYSIWYG XML редактор, многоканално публикуване, пълна поддръжка за мултимедийни и сложни модулни проекти, Webhelp инструмент за безпроблемна интеграция на documentация в активни уебсайтове и т.н.
ClickHelp също така предоставя доста мощна уеб платформа за софтуерна documentация под формата на бази от знания, често задавани въпроси, уроци и други помощни формати. Поддържа множество формати като Word, HTML, RTF, CHM, ODT, CHM, HTML5 уеб помощ, PDF, DOCX и т.н. Някои от характерните функции на ClickHelp са патентовано търсене в пълен текст, което улеснява намирането на конкретни теми or статии автори и потребители, Howто и избор от няколко предварително изградени шаблона за дизайн на documentацията.
Инструменти за заснемане на екрана
Повечето софтуерна documentация и помощни материали трябва да включват екранни снимки, така че би имало смисъл да направите кратък преглед на най-добрите инструменти за заснемане на екрани.
Ако използвате Windows като ваша операционна система, той идва с инструмент за изрязване, който ви позволява да правите екранни снимки на целия екран, отделни прозорци or част от екрана и да използвате инструмента за писалка, за да подчертаете някои конкретни части от екранната снимка.
FireShot е популярен плъгин за браузър, който поддържа почти всички съвременни браузъри като Chrome, Firefox, Internet Explorer и Opera. Позволява ви да заснемете цялата уеб page or няHowва конкретна част от нея.
SnagIt е по-сложен инструмент за заснемане на екран. Позволява ви да заснемате области за превъртане на всяка page, Howто и да поддържа видеозапис. Можете също да използвате тази картина, за да създавате GIF файлове и да записвате конкретни набори от действия на екрана.
Проверка на правописа и граматиката
Уверете се, че вашата documentация е написана правилно, без граматически и пунктуационни грешки, също е важно. Ето някои от инструментите, които ще ви помогнат да откриете грешки в текстовете си и да ги коригирате.
Една от най-популярните безплатни онлайн програми за проверка на правописа и граматиката. Писателите могат да идентифицират и коригират над 250 различни вида грешки, включително съществителни, местоимения, предлози, глаголи, омоними, пунктуация, типография и т.н.
Като допълнение към показването на правописни и грешки във вашите текстове, Grammar.com ви предоставя подходящи предложения, Howто и граматически правила и електронна книга за подобряване на вашето писане (всичко безплатно).
„Без meaning колко прекрасна е вашата библиотека и колко интелигентен е нейният дизайн, ако вие сте единственият, който я разбира, няма да е от полза. Документацията означава не само автоматично генерирани препратки към API, но и анотирани примери и задълбочени ръководства. Имате нужда и от трите, за да сте сигурни, че вашата библиотека може лесно да бъде възприета,” каза Никълъс Закас, известен фронтенд инженер и автор на книги. Ето защо днес решихме да разгледаме някои от най-добрите и най-често използвани инструменти за софтуерна documentация и техническо писане.
GO TO FULL VERSION