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

Чтобы прояснить, мне интересно знать, что люди думают, что вы должны реализовать, пока еще работаете над одним человеком (контроль исходного кода команды, документация, сборки и т. Д.), И что не нужно делать до того момента, когда придет второй человек. на проект. Любой, у кого есть опыт в продвижении по этому …

13 project-management  version-control  development-process  documentation  builds 

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

13 design  documentation 

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

13 project-management  documentation 

У меня есть база данных MongoDB, которую я хочу правильно задокументировать в своей схеме. Я знаю, что MongoDB является базой данных NoSQL и по своей природе не имеет схемы, но я применяю схему в своем приложении и хочу представить ее лучше, чем вывод findOne()результата. Я вижу много людей, использующих ER …

13 documentation  uml  nosql  mongodb  diagrams 

Закрыто . Этот вопрос нуждается в деталях или ясности . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Добавьте детали и проясните проблему, отредактировав этот пост . Закрыто 4 года назад . RFC : Запрос на комментарии (RFC) - это меморандум, опубликованный Инженерной рабочей группой по Интернету …

12 learning  documentation 

Я разработчик программного обеспечения, работаю в компании по встраиваемым системам. У нас есть менеджер проекта, который заботится об общем графике проекта (включая электричество, качество, программное обеспечение и производство), поэтому его график программного обеспечения очень короткий. У нас также есть менеджер программного обеспечения, который мой начальник. Он заставляет меня писать и …

12 design  project-management  development-process  documentation 

Есть ли хороший термин, который похож, но отличается от «не рекомендуется», чтобы означать, что метод или API находятся в базе кода, но не должны использоваться, потому что их реализация не завершена или, вероятно, изменится? (Да, я знаю, эти методы не должны быть общедоступными, яда, яда, яда. Я не создавал свою …

12 documentation  terminology  api  documentation-generation  javadocs 

Важно : у нас нет проблем с документацией по исходному коду . Это относится к регулярному аудиту кода и постоянно обновляется. Наша проблема с документацией для разработчиков (или, если хотите, «внешней»), небольшими подсказками, похожими на блог, от программистов до программистов, которые, как правило, когда-то пишутся, часто остаются позади. Мы используем …

12 project-management  agile  documentation 

Когда мы говорим «документация» для программного продукта, что это включает и что не должно включать? Например, недавно был задан вопрос, считаются ли комментарии документацией? Но есть много других областей, для которых этот вопрос также является действительным, некоторые более очевидные, чем другие: Руководства (очевидно) Примечания к выпуску? Учебники Комментарии Любые другие? …

12 documentation  terminology 

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

12 documentation  maintenance  knowledge-transfer 

Я должен задокументировать свою программу для школьного проекта, и у нас есть раздел, который называется «проблемная область», но я не знаю, что обсуждать в этом разделе. Итак, вопрос: что следует обсуждать в проблемной области?

12 documentation  definition 

В настоящее время мы используем систему под названием AsciiDoc, которая позволяет нам создавать документацию в простой текстовой разметке. Из этого мы можем генерировать несколько выходных форматов. Мы используем только форматы вывода PDF и CHM. Мне было интересно, если есть альтернатива ЧМ? То, что я ищу, - это то, что можно …

12 documentation  html  help-documentation 

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

12 open-source  documentation 

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

12 documentation  project  management  requirements 

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

12 experience  documentation  journal