Чтобы прояснить, мне интересно знать, что люди думают, что вы должны реализовать, пока еще работаете над одним человеком (контроль исходного кода команды, документация, сборки и т. Д.), И что не нужно делать до того момента, когда придет второй человек. на проект. Любой, у кого есть опыт в...
В настоящее время я использую две системы для написания документации кода (я использую C ++): Документация о методах и членах класса добавляется рядом с кодом в формате Doxygen. На сервере Doxygen запускается на источниках, поэтому вывод можно увидеть в веб-браузере Страницы обзора (описывающие...
В настоящее время я занимаюсь обновлением проектного документа, чтобы он был правильным и актуальным для будущих разработчиков. В настоящее время документ фокусируется только на фактах, представляющих дизайн. Нет никакого обоснования для любых представленных решений. Я считаю, что важно найти...
У меня есть база данных MongoDB, которую я хочу правильно задокументировать в своей схеме. Я знаю, что MongoDB является базой данных NoSQL и по своей природе не имеет схемы, но я применяю схему в своем приложении и хочу представить ее лучше, чем вывод findOne()результата. Я вижу много людей,...
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 6 лет назад . Для проекта мне нужно работать с различными типами...
Мне интересно, что было бы формальным и наиболее распространенным методом документирования бизнес-правил? Также, как вы документируете спецификации пользовательского интерфейса для артефактов разработки (например, Документирование полей формы и как кнопки ведут себя на форме, информационный текст и...
Я разработчик программного обеспечения, работаю в компании по встраиваемым системам. У нас есть менеджер проекта, который заботится об общем графике проекта (включая электричество, качество, программное обеспечение и производство), поэтому его график программного обеспечения очень короткий. У нас...
Есть ли хороший термин, который похож, но отличается от «не рекомендуется», чтобы означать, что метод или API находятся в базе кода, но не должны использоваться, потому что их реализация не завершена или, вероятно, изменится? (Да, я знаю, эти методы не должны быть общедоступными, яда, яда, яда. Я...
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 6 лет назад . Я создатель растущего проекта с открытым исходным...
Важно : у нас нет проблем с документацией по исходному коду . Это относится к регулярному аудиту кода и постоянно обновляется. Наша проблема с документацией для разработчиков (или, если хотите, «внешней»), небольшими подсказками, похожими на блог, от программистов до программистов, которые, как...
Закрыто . Этот вопрос нуждается в деталях или ясности . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Добавьте детали и проясните проблему, отредактировав этот пост . Закрыто 4 года назад . RFC : Запрос на комментарии (RFC) - это меморандум, опубликованный Инженерной...
Когда мы говорим «документация» для программного продукта, что это включает и что не должно включать? Например, недавно был задан вопрос, считаются ли комментарии документацией? Но есть много других областей, для которых этот вопрос также является действительным, некоторые более очевидные, чем...
Мы смотрим на обновленную документацию по всей нашей продуктовой линейке. Часть этого включает справочные руководства для языка программирования, используемого как часть системы. При написании справочного руководства для языка программирования, каков наилучший способ структурировать его для...
Я понимаю разницу между ними, но мои коллеги спрашивают меня о преимуществах маркировки требований как функциональных или нефункциональных (или переходных). Зачем это делать? Он провел, как он сказал, два дня, просматривая список требований для одного проекта, и не увидел в этом никакой пользы,...
В настоящее время мы используем систему под названием AsciiDoc, которая позволяет нам создавать документацию в простой текстовой разметке. Из этого мы можем генерировать несколько выходных форматов. Мы используем только форматы вывода PDF и CHM. Мне было интересно, если есть альтернатива ЧМ? То,...
Я должен задокументировать свою программу для школьного проекта, и у нас есть раздел, который называется «проблемная область», но я не знаю, что обсуждать в этом разделе. Итак, вопрос: что следует обсуждать в проблемной...
W3Schools имеет репутацию неполного, иногда неправильного и занятого рекламой; Тем не менее, при поиске некоторых вещей или ссылки на документацию при ответе на вопрос SO, он по-прежнему является единственным удобным кросс-браузерным ресурсом. Есть и другие ресурсы, такие как Mozilla Developer...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 4 года назад . Каждый раз, когда я заканчиваю проект, всегда есть что-то, чему я научился...
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 4 года назад . Наша компания собирается приобрести исходный код...
После долгих поисков я не смог ответить на основной вопрос, касающийся предполагаемого известного в мире разработки программного обеспечения: ЧТО ИЗВЕСТНО: Применение строгой политики в отношении надлежащей документации по коду (будь то теги Doxygen, Javadoc или просто обилие комментариев)...