Вопросы с тегом «documentation»

Я (случайно) исследовал основанные на семантике / онтологии подходы к технической документации, когда наткнулся на этот драгоценный камень : Грамотное программирование и семантическая паутина - это идеи разных времен, у которых есть связь. Связанная статья, Нормальное программирование в XML Нормана Уолша, обсуждает технологии XML, которые являются центральными для семантической сети, …

9 documentation  semantic-web  literate-programming 

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

9 documentation 

Во-первых, я понимаю, что этот вопрос может быть несколько длинным и расплывчатым, и я прошу прощения за это. Вероятно, это основная проблема с коротким именем для любого, кто "получил его", но, поскольку мне не хватает в этом отношении, пожалуйста, потерпите меня при описании проблемы. Так или иначе я занимаюсь программированием …

9 documentation  design  modeling 

Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 4 года назад . Мы находимся в плохой ситуации, когда у нас очень мало документации …

9 documentation 

Я хочу написать Javadoc в сухом виде. Но документ оракула о Javadoc говорит, что напишите то же самое снова в комментарии метода перегрузки. Могу ли я избежать повторения?

9 documentation  comments  dry  javadocs 

Я беру свое первое приложение корпоративного уровня и хочу, чтобы моя команда смоделировала все приложение ASP.NET MVC C # еще до того, как мы выполним одну строку кода. ОБНОВЛЕНИЕ: Это не было философской дискуссией о том, когда документировать / моделировать приложение. Пожалуйста, предоставьте ответы только для того, «как» документировать / …

9 c#  asp.net-mvc  documentation  uml 

Таким образом, вы исправляете ошибки, а затем встречаете одну, которая может повлиять на другие модули программного продукта. Ваши данные недостаточны для подтверждения вашего утверждения о последствиях исправления, и вас попросили создать документ анализа воздействия. Есть ли определенный процесс, как это сделать? Какая ключевая информация нужна? Существуют ли какие-либо известные форматы …

9 project-management  documentation 

Я ищу способы улучшить управление требованиями. В настоящее время у нас есть документ Word, опубликованный на веб-сайте. К сожалению, мы не можем (насколько мне известно) смотреть на изменения от одного пересмотра к другому. Я бы предпочел быть в состоянии сделать это, очень похоже на вики или VCS (или оба, как …

9 documentation  project-management  wiki  requirements 

Это может быть глупый вопрос, но это было в моей голове некоторое время, и я не могу найти достойного ответа где-либо еще. У меня есть учитель, который говорит, что мы должны явно перечислить каждый параметр с описанием, даже если он только один. Это приводит к большому количеству повторений: double MyFunction(const …

9 documentation  comments  coding-style