Учебники

Документация — это ключ

Я получил степень магистра по компьютерам и приложениям, и я был так увлечен написанием исходного кода даже без полного понимания и документирования требований. Проектная документация и документация по тестовым сценариям нигде не были в жизненном цикле разработки программного обеспечения … был прямой переход к кодированию.

На более поздних этапах у меня возникли большие проблемы, и вскоре я понял, что Документация — это ключ к успеху разработчика, тестировщика или архитектора программного обеспечения.

Компьютерная документация

Прежде чем приступить к разработке небольшого или большого программного обеспечения, у вас должен быть ответ на следующие вопросы:

  • Где находится спецификация требований?

  • Где находится документ по анализу воздействия?

  • Где находится проектный документ?

  • Правильно ли вы документировали все предположения, ограничения?

  • Вы сделали обзор всех документов?

  • Получили ли вы подпись на всех документах от всех заинтересованных сторон?

Где находится спецификация требований?

Где находится документ по анализу воздействия?

Где находится проектный документ?

Правильно ли вы документировали все предположения, ограничения?

Вы сделали обзор всех документов?

Получили ли вы подпись на всех документах от всех заинтересованных сторон?

Если у вас есть положительные ответы на все вышеупомянутые вопросы, вы в безопасности и готовы приступить к кодированию. Во многих организациях будут соблюдаться строгие правила, а в других — нет. Рекомендуется заполнить всю необходимую документацию и получить соответствующие разрешения, прежде чем приступить к кодированию программного обеспечения.

То, что вы узнаете сегодня, готовит вас к завтрашнему дню!

Итак, опять же, это одна из лучших практик, чтобы иметь как можно больше документации. Несколько важных документов, которые подготовят вас к будущему:

  • Дизайн Подходы
  • Секреты и уловки
  • Специальные функции, команды и инструкции
  • Уроки выучены
  • Особые ситуации
  • Методы отладки
  • Лучшие практики
  • Все, что может помочь вам в будущем

Хранение документов в электронном виде не стоит вам. Итак, начнем вести необходимую документацию.