Предположим, что вы единственный разработчик, уходящий с работы. Какую информацию / материал, помимо самого кода, вы должны создать и оставить для замены? Очевидный ответ: «все, что вы хотели бы получить на новой работе», конечно, но прошло уже много времени с тех пор, как я начал новую работу, и я...
Недавно я работал над рефакторингом частей базы кода, с которыми я сейчас работаю, - не только для того, чтобы лучше понять это, но и для того, чтобы облегчить работу тех, кто работает над кодом. Я склонен полагать, что самодокументированный код - это хорошо . Я просто думаю, что это чище, и если...
Я изучал способы более формального документирования программных проектов и узнал о IEEE 830-1998: рекомендуемая практика для спецификаций требований к программному обеспечению . Однако, как видно из этой ссылки, она была заменена. Я знаю, что 830-1998, и, возможно, даже 830-1993, вероятно, просто...
Мы все видели бесчисленные примеры программного обеспечения, которое поставляется с «минимальными системными требованиями», например: Windows XP / Vista / 7 1 ГБ ОЗУ 200 МБ для хранения Как они вообще определяются? Очевидно, что иногда существуют определенные ограничения (если программа занимает...
Один из разработчиков в моей команде считает, что необходимо написать комментарий javadoc для КАЖДОГО параметра в сигнатуре метода. Я не думаю, что это необходимо, и на самом деле я думаю, что это может быть даже вредно. Прежде всего, я думаю, что имена параметров должны быть описательными и...
Мне очень нравится дизайн языка программирования. Иногда я думаю, что мои языковые проекты и их потенциальные пользователи выиграют от всеобъемлющего документа по стандартам. Я смотрел на многие языковые стандарты, начиная от очень формального (C ++) до довольно неформального (ECMAScript), но я не...
Если JSON обозначает нотацию объекта JavaScript, то когда вы говорите «объект JSON», не говорите ли вы «объект нотации объекта JavaScript»? Было бы правильнее сказать «строка JSON»? Или было бы правильнее просто сказать JSON? (как в «Эти два сервиса передают JSON между...
В настоящее время я работаю с профессором в моем университете, чтобы разработать новые учебные планы для курсов разработки программного обеспечения и дизайна Capstone, предлагаемых в моем колледже. До недавнего времени на обоих курсах использовалась исключительно модель водопада, и поэтому студенты...
Закрыто. Этот вопрос не по теме . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он соответствовал теме разработки программного обеспечения стека Exchange. Закрыто 6 лет назад . Я ищу программное обеспечение для организации и ведения внутренней...
Сколько технической (для будущих разработчиков) документации достаточно ? Есть ли подходящее соотношение между часовым кодированием и документированием часов? Пападимулис утверждает, что вы должны производить наименьшее количество документации, необходимой для достижения наибольшего понимания, Это...
У меня есть несколько вопросов о написании спецификации, и они: Когда мы пишем спецификацию программного обеспечения, в разделе «Определение требований пользователя» мы должны указать только «Функции» и «Ограничения»? «Интерфейс пользователя» попадает в «функции» или «ограничения»? На какие...
Я работаю в компании, занимающейся системами управления, где основной работой являются SCADA и PLC , а также другие сотрудники систем управления. На самом деле, разработка программного обеспечения - это не то, чем занимается компания, за исключением маленьких кусочков, пока не было принято решение...
Я работаю над продуктом для клиента, который должен быть действительным и соответствовать цели. Он построен на стеке LAMP (PHP / Cake), поэтому есть лицензии GPL, MIT, PHP, APACHE: «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ ИЛИ УСЛОВИЙ ЛЮБОГО ВИДА, явных или подразумеваемых, включая, без ограничений,...
Наша компания находится в процессе преобразования большого количества ручных бизнес-процессов (и связанных с ними институциональных знаний) в новое корпоративное программное обеспечение. Проект продвигается действительно хорошо, но по мере того, как мы продвигаемся, становится ясно, что существует...
Я ищу формат документации информативного класса для моих классов Entity, Business Logic и Data Access. Я нашел следующие два формата отсюда Формат 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> ///...
Недавно я наткнулся на то, насколько полезны неизменяемые объекты и что, например, если вы передаете элементы конструктору и ваш класс должен быть неизменным, вы должны скопировать эти элементы, если они сами не являются неизменяемыми. Это требует много проверок или знаний о моем проекте, потому...
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто 4 года назад . Аналогично тому, как проекты с открытым исходным...
Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 4 года назад . В настоящее время я изучаю Python, который не был частью моей учебной...
Мы интегрируем процесс тестирования в наш процесс SCRUM. Моя новая роль - писать приемочные тесты наших веб-приложений, чтобы потом их автоматизировать. Я много читал о том, как должны быть написаны тестовые случаи, но ни один из них не дал мне практических советов по написанию тестовых случаев для...
У меня есть база данных MongoDB, которую я хочу правильно задокументировать в своей схеме. Я знаю, что MongoDB является базой данных NoSQL и по своей природе не имеет схемы, но я применяю схему в своем приложении и хочу представить ее лучше, чем вывод findOne()результата. Я вижу много людей,...