Стандарти за документация, PHPClub - Клуб на разработчиците на PHP
елбиррет елчно
Стандарти за документация?
Всъщност е необходимо да се разработи техническа документация, според която в бъдеще програмистът (в общия случай това е друг човек) ще може след прочитане да разбере и изпълни задачата. Има ли някакви стандарти за този вид документация? Или цялото това щастие се прави според правилата, установени в една компания? Харесва ми
Drosera anglica
елбиррет елчно
Можете да споделяте информация и изобщо не е жалко, особено след като тук няма нищо тайно, но може да помогне на някого Не знам как е навсякъде, но ние работим приблизително така. Има шаблон за Word документ, с горни и долни колонтитули, лога, който се използва за документация (след това се отпечатва за клиенти). Ръководителят на проекта или водещият програмист на проекта получава ТЗ от властите за някои характеристики на проекта. След това той или след консултация с останалите разработва концепция. Първо, всичко това е одобрено от властите, т.е. няколко версии на документа (_v1, _v2, vXXX) се получават преди окончателната версия. След това той възлага тази задача на няколко души и прикачва този документ. Ако в процеса на внедряване програмистът види по-оптимални начини за изпълнение, тогава той променя документа и го поставя в папката с документация на проекта от новата версия, като уведомява лицето, което му е поставило тази задача. Действителната структура на документа: Първоначално информация като Заглавие: Статистика на потребителя Проект: Пример ID на документа: - ако се използва някакъв вид система за управление на документи. Автор: Vasya Pupkin Версия: V6 Дата: 28-12-2006 Статус: Подготовка (или за корекция, одобрен)
Може да е таблица с промени Кой Кога Цел на промените
Други основни раздели: 1. Описание на това, което трябва да се внедри (2-3 параграфа), връзки към съществуващи аналози, може да има допълнителна документация, която трябва да се прочете преди започване на работа. 2. Как ще изглежда всичко, ако има GUI елементи (линкове към екранни снимки или прикачени документи) 3. Изпълнение: a. основна информация за точките, на които да обърнете внимание. б. ако е внедрен GUI, тогава описание на всички страници, тяхната цел. c. Списък с нови класове с интерфейс за всеки d. Какви са промените и връзките в базата данни 4. Интегриране в системата: възможно е да създадете някои права за достъп или други функции. 5. Изчисляване на производствените ресурси: колко души, колко хора / часове за всеки от горните елементи + време за тестване и корекции на открити грешки. Изчисленията разбира се са приблизителни. 6. Допълнителни бележки.
Системата не е идеална, но работи. Мисля, че в тази област няма стандарти и всяка компания сама изгражда този процес, някой няма достатъчно хора, които да създават и поддържат този вид документация, някой просто няма нужда от нея и всичко зависи от клиента, който може да направи предпоставка за поддържане на проектна документация на всички етапи от проекта. Винаги можете да го направите както искате