Ако все още не документирате вашите програми, Банки - пари - кредит
Не е необходимо да чакате програмистите изведнъж да започнат сами да пишат потребителски документи (и ако това се случи, тогава такива програмисти трябва да си струват теглото в злато). Най-ефективният начин, по мое мнение, е да се образоват потребителите на самоуважение и вярата, че трябва да изискват писмена информация от програмистите относно работата с програми. Нека счетоводител или икономист се представи не само като потребител, но и като клиент (в края на краищата банката наема програмисти, за да разработят програмите, от които се нуждае) и осъзнава, че има право да изисква цялата информация, необходима за работа във форма, която минимизира броя на обажданията до програмисти.
Ако искате да държите ситуацията под контрол, интересувайте потребителите от добра документация (писането й е отделна тема). В една банка отделът за автоматизация не може да прави само това, което смята за правилно, но трябва да прави това, от което банката се нуждае. От политическа гледна точка е важно да се убедят потребителите, че появата на документация ще реши техните проблеми, свързани с работата на програмите.
Как да накараме потребителите да се интересуват от документацията? Като начало можете да направите няколко малки (8-10 страници) документа, които описват най-използваните функции на програмите (например въвеждане и отпечатване на платежно нареждане, следене на платежни нареждания и др.). Не забравяйте, че колкото по-дълъг е документът, толкова по-малка е вероятността да бъде прочетен до края. Опитайте се да създадете на първо място кратък, ясен и точен документ и, разбира се, полезен за потребителите. Раздайте го на служителите на бизнес единицата. Покажете, че е по-добре да прекарате половин час в четене на документ, отколкото безкрайно да се обаждате. Опитайте се да получите критични коментари по документите от тези служители. Изисквайте това вотделът за автоматизация, в отговор на обажданията на потребителите, прозвучаха думите: „И това е написано в такъв и такъв документ.“ С други думи, създайте прецедент за успешното използване на документацията. Не излизайте с официални отговори, опитайте се да заемете мястото на потребителя и да му дадете необходимата информация. Ако сте направили всичко правилно, скоро може да се наложи отделът за автоматизация да предостави документация за нови програми. В бъдеще поръчките за разработване на документация трябва да идват от бизнес звена.
Инициативата се наказва с екзекуция
Чрез увеличаване на потребителското търсене на документация, вие ще се изправите пред задачата да организирате процеса на документиране. Как да процедираме? Ако средствата позволяват, по-добре е да наемете специалист по потребителска документация. Неговата задача не е да пише всичко за всеки, а да организира създаването, проверката, освобождаването, осчетоводяването и актуализирането на потребителски документи. Ако не е възможно да се наеме технически писател, тогава ръководителят на отдела за автоматизация или неговият заместник може и трябва да контролира разработването на потребителска документация.
Забелязано е, че добрите програмисти, които разработват своите програми внимателно и внимателно, като правило, описват добре (ясно, просто, напълно) възможностите на програмите. За пореден път се убеждавате: който ясно мисли, той ясно заявява. Когато четете глупави документи, човек получава впечатлението, че програмата е написана в подобен стил (това често се потвърждава на практика). Обяснението на това явление се крие, струва ми се, в нивото на общата култура на човека. Човек мисли за другите, поставя се на мястото на потребителя и пише програми и документи по такъв начин, че да изпиташ радостта от използването и четенето им. Другият е запален от страст за писане на код и създава нещо само по себе си, та дориправи описание, в което е много трудно да се разбере нещо („моите мисли са моите коне“).
Задачата на документацията е да създаде документация на базата на материал, който е разнороден по стил, който да се превърне в система с единен дизайн и ясна форма на представяне.
Документацията е счетоводно-контролна
Голям брой итерации също могат да показват, че проблемът не е в документа, а в темата, която той описва. Ако създаването на документ помага да се види и реши незабелязан преди това важен проблем, тогава това е много добър резултат, който подобрява качеството на софтуера.
Процедурата за издаване (одобрение) на документи също се определя във всяка банка самостоятелно. Полезно е да се включат служители на потребителски отдели в издаването на документи (например изискване на подпис върху лист за одобрение). Първо, ръководството на отделите на банката ще види, че отделът за автоматизация е зает с работа, в която бизнес отделите се интересуват, и второ, участието на потребителите дава увереност, че наистина необходимите документи се разработват.
Изключително полезно е да се предадат почти готови документи на малка група напреднали потребители, които разбират значението на създаването на потребителска документация и са готови да направят максимален брой критики. Опитът показва, че във всяка организация задължително има няколко такива служители. Желателно е тяхната енергия да се използва с най-голям ефект. Ако установите сериозни бизнес отношения с тях, тогава такива служители могат значително да помогнат при създаването на потребителска документация.
Взаимодействието с напреднали потребители има и друг положителен ефект, в допълнение към подобряването на качеството на документите: „експертен потребител“ в бъдеще става консултант „наместоположение" за други потребители.
Ако се публикуват много документи и се спазват всички необходими процедури, вероятно ще има ситуации, при които потребителската документация ще изостава от версиите на софтуера. Тук е важно да не доведете нещата до точката на абсурда (когато документацията за предишната версия се доставя заедно със следващата версия на програмата), а да управлявате процедурата за освобождаване, така че забавянето да не стане критично.
Има и друг проблем с продължителността на процедурата по освобождаване. Програмистите могат сами да започнат да раздават чернови на документи на потребителите, без изобщо да се интересуват, че качеството на тези документи може да отблъсне читателите, вместо да ги привлече.Важно е да се прави разлика между официални и "партизански" документи. Банката трябва да е наясно, че отделът за автоматизация отговаря заофициално издадените от нея документи. Ако програмистът разпространява документи самостоятелно, тогава, първо, подобни действия трябва да бъдат спрени, и второ, „партизански“ документи трябва да бъдат уловени и превърнати в официални с изпълнението на всички етапи на проверка и освобождаване на документи.
Потребителите трябва да бъдат информирани за съхранението на официални потребителски документи (например, ако се съхраняват файлове с документи, тогава се отчита директорията на мрежовия сървър). Документите трябва да бъдат взети от това хранилище. Очевидно само едно лице в банката (т.нар. библиотекар) може да има право да добавя (изтрива) документи в хранилището. Потребителската документация е собственост на банката и може да съдържа информация с ограничен достъп. Това трябва да се помни постоянно и да не се оставя раздаването на документи да върви по пътя си. Определете реда за достъп на банковите служители до трезора, може и в съчетание с услугатазащита на информацията.
Официалните документи трябва да имат подходяща форма. Те трябва да имат единен стил на дизайн, като се започне от заглавната страница и се стигне до приложения. За да придадете на документите безупречен вид, е желателно да улавяте грешки (печатни грешки).
По-добре малко сега, отколкото много, но след това
Ако ресурсите не позволяват документацията да бъде публикувана едновременно с програмата, тогава можете първо да опишете основните функции и да ги пуснете по съкратена процедура (например след редактиране от лицето, отговорно за документацията), и да пуснете пълното издание по-късно (но не когато вече не е необходимо). Наличието на две процедури спомага за гъвкавото управление на освобождаването на документи. За малки проекти, където скоростта е важна, винаги можете да използвате процедурата за бърз достъп. За големи проекти, които очакват голям брой потребители, използвайте нормалния процес на издаване.
. А опитът е син на трудни грешки.
При разработването на потребителска документация трябва да се вземе предвид световният опит, изразен в международни и национални стандарти на водещи компютърни държави. Обърнете внимание на документацията на големите компютърни компании, оценете приложимостта на техните разпоредби. Също така помага да напишете вътрешен нормативен документ относно процедурата за създаване на потребителски документи, в който трябва да дефинирате процедури за съгласуване, актуализиране, одобряване и разпространение на документи. Мерките по съкратената процедура също трябва да бъдат предвидени в нормативния документ. Назначаване на служител, който да следи за изпълнението на процедурата по изготвяне и издаване на потребителски документи. Правото да одобрява пускането на програми и прехвърлянето на документацията остава за ръководството.
Изкуство заради самото изкуство или.
Ако е включенона клетката с лъва пише тигър.
Не е лесно да създавате документи в среда с ограничени ресурси, но е още по-трудно да ги поддържате актуални, особено ако много документи се натрупват с течение на времето. Поддържането на документация е трудоемък процес. Понякога актуализирането на документ е сравнимо по време с разработването на нов. Удобен начин е издаването на допълнения към документи, които описват нови функции. С течение на времето, когато има много такива допълнения, е препоръчително да се пусне ново издание на основния документ.