Как документировать программные алгоритмы?

Question

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

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

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

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

Answer 1

Возможно, вам следует использовать псевдокод.

Answer 2

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

Answer 3

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

Answer 4

Помогла ли вам помощь data flow diagrams? Поместите код psuedo или математику в пузырьки. У меня был некоторый успех, сочетающий модели потоков данных и диаграммы отношений сущностей, но он нестандартен.

Answer 5

Что касается Насси-Шнейдерман-Диаграммы, это диаграмма структурного программирования. Я думаю, что это хорошо, чтобы показать потоки решений.

http://en.wikipedia.org/wiki/Nassi%E2%80%93Shneiderman_diagram

Answer 6

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

Answer 7

Создайте два документа.

• Первое: модель (BPM) бизнес-процесс, который показывает последовательность шагов, необходимых для быть сделано. Это должно быть аннотировано с деталями для каждого шага.

• Второе: Создайте таблицу с каждым элементом входных данных, определенной таким образом, что бизнес может видеть, что вы понимаете, типа поля для ввода каждой точки данных и правил для каждой точки данных. Если в расчете используется таблица для шага, тогда вы определяете значение входного поиска из таблицы. Поэтому для каждого шага вы знаете, откуда поступают данные, а затем идут. Ваша электронная таблица может включать ссылку на BPM, чтобы они могли проходить через каждую точку данных в BPM и видеть, откуда она идет.