выявление улучшений кода

Question

Мы только что прошли довольно серьезную переписку системы, и меня попросили найти и идентифицировать области кода, которые были улучшены. как способ доказать клиенту, что затраченные нами усилия стоили того. Идентификация областей на самом деле не самая сложная часть, но я борюсь с тем, как лучше представить эту информацию. Будем весьма благодарны за любые предложения по этому поводу, или если кто-то сделал что-то подобное в прошлом.

Answer 1

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

• Снижение количества дефектов в результате более совершенных и понятных API.
• Более быстрое время разработки (и более низкие затраты), поскольку интерфейсы проще тестировать и имеют меньше точек интеграции.
• Проще поддерживать старый код, потому что слои, от которых они зависят, теперь будут чище и свободнее от лишних.

Некоторые из них будут немедленными, однако:

• Более быстрая сборка, потому что там меньше разводов.
• Идентификация ошибок, которые не были обнаружены до производства, потому что модульное тестирование этих областей было слишком сложным.
• Лучшее разделение слоев и проблем.

Степень, в которой применяются эти виды преимуществ, будет, конечно, зависеть от вашего проекта и его кодовой базы.

Answer 2

Так как это не для технических людей, я бы предложил столбчатые и круговые диаграммы. Ничто не помогает нетехническим людям понять сложные предметы, такие как большой красочный график.

Answer 3

Это зависит от клиента: клиент технически настроен? Они внутренние или внешние? Сколько деталей они хотят? Вас попросили переписать, и если да, то кем и по какой причине?