10. Управление на документацията Документация предназначена за разработчиците
Изтегляне 40.15 Kb.
|
- Навигация на страницата:
- За обектно-ориентираното програмиране е важна самата
10. Управление на документацията
При разработката на даден софтуерен продукт съществуват две страни. От едната страна е клиентът, а от другата екипът, който разработва софтуера. Клиентът извършва бизнес решенията и е наясно с необходимостите и приоритетите. За да се изясни на програмистите какво точно трябва да се направи се провеждат редица дискусии. По-важните неща от тези дискусии се съхраняват под формата на разпечатани таблици и текст. По някога е от полза записването на части от разговора между клиента и програмистите. За екипа е важно да разполага с някои графики, свързани с дизайна на продукта, както и UML диаграми. Удобно е някои основни и важни за проекта неща да стоят за по-дълъг период на стените. Така се спестява постоянното питане за едно и също нещо.
От голямо значение е и документацията на промените по сорс кода. Така се знае по кое време какво е променено, както и кой е извършил промените. Тази информация се съхранява в програмата, която се използва за контрол на сорсовете. Тези данни могат да се съхранят в удобен за четене текстов файл и да се извади разпечатка на промените във времето. Това е удобно, когато се работи с няколко екипа с различно географско положение. В този случай се ползват отделни програми за съхраняване на сорсовете, които не са синхронизирани.
Както стана дума в по-горните глави е полезно ползването на тестове по модули преди тестването на готовия продукт. Тези тестове (unit tests) от своя страна съставят текстови файлове с информация за представянето на модулите или резултат от тестовете – грешки и успехи. Добре е да има възможност за настройка на изходните параметри – име и формат на файла, филтрация на информацията. При филтрирането е важно да може да се задава кое да се записва във файла – фатални грешки, обикновени грешки, допълнителна информация. От файла трябва да става ясно къде е възникнала грешката – в кой модул, в коя функция, в кой тест.
Важно за програмистите е кодът да е написан прегледно. Добре е да се ползват общи правила в подредбата, така че да е удобно за всички в екипа. Полезна е и документацията на кода. Съществуват автоматизирани програми, които създават документация под формата на HTML страници или под формата на компилиран HTML (Compiled HTML Help file: .chm). Така е възможна бърза навигация и търсене на необходимите функции, класове и др. Добре е към тази документация да се включват и кратки примерни програми, които показват начина на ползване на определени модули. Често тези примери са подобни на кода използван за тестване на модулите.
с диаграми взаимодействието между отделните модули. Когато работата се разделя между чуждестранни екипи е нужно да се изготви документация на различни езици. Тази опция е предвидена в програмите за автоматично съставяне на документация.
подобен на компилаторите. Те анализират коментарите в кода. Всяка такава програма има собствени команди, които се вмъкват в коментарите. В повечето случаи от кода се генерират XML файлове, съдържащи информация за класове, функции и др., както и тяхното описание. Тези файлове позволяват гъвкавост на изходния формат. От тях можем да получим както HTML файл, така и обикновен текстов файл. Програмите за документация предлагат разнообразие от изходни формати, но ако ни е нужно нещо специфично, то тогава използваме XML файловете. Чрез транслатори, като XSLT е възможно чрез собствени шаблони да получим търсения формат и дизайн на изходния файл.
За обектно-ориентираното програмиране е важна саматаконструкция на модела. Съществуват няколко основни типа UML диаграми:
|
