Документація повинна бути:
- негайно. Менеджери повинні робити записи відразу після того, як стався інцидент. …
- Точний і правдоподібний. …
- Домовилися. …
- Інтернет-ресурс: Розробка прогресивної дисциплінарної політики.
Три елементи документації з якості
- Виявленість. Виявленість означає, чи може клієнт швидко знайти інформацію, яку він шукає? …
- Читабельність. Читабельність означає, чи може клієнт легко прочитати вміст сторінки? …
- Юзабіліті.
відповідність, узгодженість і повнота Ця ситуація часто є результатом відсутності достатнього часу для документування на етапі планування або недостатнього початку документального завдання на життєвому циклі проекту. Отже, як ваша проектна або технологічна документація зіставляється з 3 C's of відповідність, послідовність і повнота?');})();(функція(){window.jsl.dh('dofjZpSdIfqE4-EP3_ClUA__51','
Принципи якісної документації[ред редагувати джерело] Запишіть у хронологічному порядку. Записуйте лише фактичну інформацію, а не свою думку. Пишіть розбірливо, при необхідності друкуйте.
Є три типи документації, яка потрібна кожній команді розробників програмного забезпечення, щоб ефективно функціонувати та уникнути перешкод у майбутньому: документація поточних обговорень, процес прийняття рішень і технічна інформація.