Запитання з тегом «documentation»

Для розробки я зацікавлений у тому, щоб знати, що люди думають, що вам потрібно ввести в життя ще один проект (контроль над джерелами, документація, складання тощо) і які речі не потрібно робити до того моменту, коли прийде друга людина на проект. Кожен, хто має будь-який досвід просування цього сценарію, їхню …

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

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

13 design  documentation 

Мені хотілося б знати, які варіанти є для документування вже розробленого проекту, оскільки розробники, над якими працювали, не написали жодної сторінки документації. У проекті немає інших деталей, окрім багатьох сторінок сценаріїв з функціями, написаними та модифікованими розробниками, які працювали над цим проектом протягом останніх 2 років. Все, що у мене …

13 project-management  documentation 

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

13 documentation  uml  nosql  mongodb  diagrams 

Закрито . Це питання потребує деталей або ясності . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Додайте деталі та уточніть проблему, відредагувавши цю публікацію . Закрито 4 роки тому . RFC : Запит на коментарі (RFC) - це меморандум, опублікований Інженерною робочою групою Інтернету (IETF), що описує методи, поведінку, …

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. Мені було цікаво, чи є альтернатива chm? Що я шукаю - це те, що можна використовувати …

12 documentation  html  help-documentation 

Закрито . Це питання має бути більш зосередженим . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб воно зосередило увагу на одній проблемі, лише відредагувавши цю публікацію . Закрито 6 років тому . Я творець зростаючого проекту з відкритим кодом. Наразі я розчаровуюся, намагаючись зрозуміти найкращий спосіб …

12 open-source  documentation 

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

12 documentation  project  management  requirements 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 4 роки тому . Кожного разу, коли я закінчую проект, я завжди щось дізнався (інакше я не вважаю …

12 experience  documentation  journal