Qsin wrote:
Здравейте,
трябва да напиша "Ръководство за програмиста". Никога не съм писал такова нещо и нямам идея какво трябва да съдържа. Приемам всякакви подсказки и идеи. Може и
Хай,
По-конкретно може да ти се отговори, ако кажеш на какво нещо ще пишеш Ръководство за програмиста.
Например, ако пишеш ръководство за програмиста на някоя софтуерна библиотека, трябва да опишеш функциите от тази библиотека (какво правят, какви параметри приемат, какъв резултат връщат), като дадеш в най-добрия случай и съответните примери за употребата на тези функции, за да поже въпросният програмист да разбере лесно как работят.
Ако Ръковоството за програмиста е за цял софтуерен продукт и идеята е например, че програмиста на клиета трябва да може да си го доразвива, тогава ръководството трябва да включва и подробно описание на структурата на софтуера - от какви модули се състои, какви са интерфейсите, които всеки от модулите предоставя (т.е. как другите модули комуникират със съответния модул); след това вътрешната организация на всеки модул трябва да е описана - от какви класове се състои модулът, като за всеки клас трябва да е дадено описание какво прави, какви методи и данни има и как се използва (съответно с примери в идеалния случай).
Разбира се, това описание трябва да е разделено на някакви логически свързани части, така че да се разбира по лесно. Искам да кажа, че е хубаво група класове от този продукт, които работят заедно и вършат някаква обща работа, да се описват заедно, за да се разбере начина им на действие най-добре. Също примерите трябва да са много близки до реалното използване на класовете в продукта.
Навсякъде казвам 'класове', но спокойно може да става дума и за не-обектно ориентиран продукт, тогава по подобен начин ще трябва да се описват съответниет функции, от които са съставени модулите.
Надявам се да съм помогнал поне малко :)
Андрей
на моя мейл директно.
Явор Атанасов
============================================================================
A mail-list of Linux Users Group - Bulgaria (bulgarian linuxers).
http://www.linux-bulgaria.org - Hosted by Internet Group Ltd. - Stara Zagora
To unsubscribe: http://www.linux-bulgaria.org/public/mail_list.html
============================================================================
-- Andrei Boyanov CEO of Active Solutions Ltd. http://activesolutions.bg; http://andrei.activesolutions.bg
============================================================================ A mail-list of Linux Users Group - Bulgaria (bulgarian linuxers). http://www.linux-bulgaria.org - Hosted by Internet Group Ltd. - Stara Zagora To unsubscribe: http://www.linux-bulgaria.org/public/mail_list.html ============================================================================
