Как да пишем софтуер документация

Една добра документация програма - независимо дали това е документ, който съдържа спецификация на изискванията за програмисти и тестери, технически документ вътрешни потребители на потребителя за софтуера или за потребител помощния файл за - помага на човек да работи със софтуера за разбиране на неговите характеристики и функции. Следвайте съветите - как да пишат документация програма за техническа и крайни потребители.

стъпки Редактиране

Метод 1 от 2:
Писане софтуер документация за техническите потребители. правило

Определи каква информация трябва да се спомене. Документи за софтуерни изисквания са справочник за дизайнерите на потребителския интерфейс, програмистите, които пишат код и тестери, че тест, независимо дали това е софтуер работи. Точна информация зависи от програмата, но може да включва следното:

• ключови файлове в заявлението. То може да бъде файлове, създадени от екип от разработчици, база данни, наречена по време на операцията по програма, както и обслужване на програма на трета страна.
• Функции и подпрограми. Това указва какъв всяка функция и подпрограма, включително входни и изходни стойности.
• Програма променливи и константи, както и как те се използват в заявлението.
• Цялостната структура на програмата. За приложения, базирани на диска, най-вероятно ще се нуждаят от описание на отделни блокове и библиотеки програмата, а и за уеб приложения се нуждаят от описание на страници, които използват файловете.

Преценете колко документация трябва да бъде в кода и колко трябва да бъдат разделени. Колкото по-техническата документация, създадена в кода, толкова по-лесно ще бъде за актуализиране код, както и документация във връзка с различните версии на оригиналното заявление. Като минимум документация в кода трябва да обясни функции, съчетания, софтуерни константите и променливите на.

• Ако кодът е доста дълго, то може да бъде превърната в помощния файл, който можете да направите търсене по ключови думи или индекс. Това ще бъде голям плюс за приложения, където логиката на програмата е разделена на няколко страници и включва редица допълнителни файлове, както и в някои уеб приложения.
• Някои езици за програмиране, като например Java и NET Framework (Visual Basic.NET, C #), имат свои собствени стандарти за документиране на кода. В такива случаи следва стандартните насоки - колко документи трябва да бъдат включени в програмния код.

Метод 2 на 2:
Писане документация софтуер за крайни потребители Редактиране

Идентифицирайте търговски съображения за архива си. Въпреки, че функционалните причините за софтуер документация - за да помогне на потребителите да разберат как да използвате приложението, има и други причини, например, да помогне за насърчаване на продукти на пазара, подобряване на имиджа на компанията и най-важното, да се намалят разходите за техническа поддръжка. В някои случаи, документацията, необходима за да се съобразят с определени правила и законови изисквания.

• При никакви обстоятелства не трябва да документацията на програмата не трябва да замества беден интерфейс дизайн. Ако екранът на приложение изисква много обяснителни документи, по-добре е да се промени дизайна на нещо по-интуитивен.