В SO https://stackoverflow.com/info/9475795/how-do-you-share-code-across-teams-working-on-very-different-projects был аналогичный вопрос, но мой вопрос заключается в написании документации.
Сценарий:
Скажем, моя команда работает над программным проектом, таким как приложение Fany-WordPad, которое имеет функцию Fancy-Word-Art (точно так же, как MS Office word Art). Теперь я написал код для главного окна (используя WPF в .Net или используя Window Builder на Java, не имеет значения, какой инструмент/язык).
Теперь, если мой коллега г-н Spongebob пишет часть Word-Art, как мне сказать ему, какие функции вызывать /Api использовать для рисования в моем окне? Например, как сообщить мистеру SpongeBob, что ему нужно вызвать метод GetWindow(), чтобы получить ссылку на поверхность чертежа, параметры, которые ему нужно пройти, и так далее?
Надеюсь, я буду здесь ясно. Это процедура?
Шаг 1: Используйте сайт вашей вики-компании, чтобы понять ваш написанный коллегой код
Шаг 2: Запишите метод GetWindow()
, чтобы он хорошо работал с остальной частью проекта
Шаг 2: Теперь поместите вики в свою интрасеть с параметрами метода/типом данных для вашего метода GetWindow()
или используйте Doxygen/Confluence, как предложено ниже
Шаг 3: Теперь его коллега мистер Спондж Боб, как найти, как нарисовать свое слово-искусство в моем окне.
Это просто не звучит правильно. С множеством функций жизнь Spongebob будет тяжелой, так же как и моя. Мы оба перебираем документацию, чтобы найти правильные функции для выполнения нашей работы. Что, если тогда я изменю GetWindow() to GetWindow(string title)
. Теперь, как я literally tell
бедный spongebob ему нужно переделать его код.
Я что-то упустил? Пожалуйста, поделитесь своим опытом, как вы справляетесь с этой проблемой в реальной среде разработки программного обеспечения? Если ваш коллега-разработчик находится в следующей таблице, действительно ли вы показываете, как реализовать определенный метод по мере их застревания, или как вы справляетесь с этой ситуацией? спасибо
Спасибо