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

Мне очень нравится дизайн языка программирования. Иногда я думаю, что мои языковые проекты и их потенциальные пользователи выиграют от всеобъемлющего документа по стандартам. Я смотрел на многие языковые стандарты, начиная от очень формального (C ++) до довольно неформального (ECMAScript), но я не могу понять, как мне разобраться и организовать такой …

16 programming-languages  documentation  standardization 

Я работаю над продуктом для клиента, который должен быть действительным и соответствовать цели. Он построен на стеке LAMP (PHP / Cake), поэтому есть лицензии GPL, MIT, PHP, APACHE: «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ ИЛИ УСЛОВИЙ ЛЮБОГО ВИДА, явных или подразумеваемых, включая, без ограничений, любые гарантии или условия НАЗВАНИЯ, НЕПРАВИЛЬНОСТИ, ТОВАРНОЙ …

15 licensing  documentation  specifications 

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

15 agile  scrum  documentation 

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

15 project-management  documentation  knowledge-management  knowledge-base 

Если JSON обозначает нотацию объекта JavaScript, то когда вы говорите «объект JSON», не говорите ли вы «объект нотации объекта JavaScript»? Было бы правильнее сказать «строка JSON»? Или было бы правильнее просто сказать JSON? (как в «Эти два сервиса передают JSON между собой».)

15 documentation  grammar  json 

У меня есть несколько вопросов о написании спецификации, и они: Когда мы пишем спецификацию программного обеспечения, в разделе «Определение требований пользователя» мы должны указать только «Функции» и «Ограничения»? «Интерфейс пользователя» попадает в «функции» или «ограничения»? На какие основные ключевые области (требования) можно разбить программное обеспечение (например, пользовательский интерфейс)?

15 documentation  requirements 

Сколько технической (для будущих разработчиков) документации достаточно ? Есть ли подходящее соотношение между часовым кодированием и документированием часов? Пападимулис утверждает, что вы должны производить наименьшее количество документации, необходимой для достижения наибольшего понимания, Это хорошее руководство, или есть конкретные вещи, которые я должен создать?

15 documentation 

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

15 programming-practices  documentation  coding-standards  standardization 

Наша компания находится в процессе преобразования большого количества ручных бизнес-процессов (и связанных с ними институциональных знаний) в новое корпоративное программное обеспечение. Проект продвигается действительно хорошо, но по мере того, как мы продвигаемся, становится ясно, что существует много путаницы в отношении терминов и определений как с точки зрения бизнеса, так и …

14 documentation  domain-driven-design 

Недавно я наткнулся на то, насколько полезны неизменяемые объекты и что, например, если вы передаете элементы конструктору и ваш класс должен быть неизменным, вы должны скопировать эти элементы, если они сами не являются неизменяемыми. Это требует много проверок или знаний о моем проекте, потому что если у меня есть public …

14 java  documentation  immutability 

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

14 learning  python  interview  documentation 

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

14 documentation 

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

14 testing  documentation  acceptance-testing 

Я ищу формат документации информативного класса для моих классов Entity, Business Logic и Data Access. Я нашел следующие два формата отсюда Формат 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: …

14 c#  documentation  comments 

В настоящее время я использую две системы для написания документации кода (я использую C ++): Документация о методах и членах класса добавляется рядом с кодом в формате Doxygen. На сервере Doxygen запускается на источниках, поэтому вывод можно увидеть в веб-браузере Страницы обзора (описывающие набор классов, структуру приложения, пример кода, ...) …

13 documentation  documentation-generation  wiki