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

Основной частью Domain Driven Design является последовательное использование повсеместного языка в системе - в разговорах, коде, схеме базы данных, пользовательском интерфейсе, тестах и ​​т. Д. Я участвую в проекте, в котором уже существует устоявшийся язык предметной области, определенный международной организацией по стандартизации. Тем не менее, мы выполняем работу для общедоступного …

10 documentation  domain-specific-languages 

Мне кажется, что вы не можете написать программную спецификацию на английском языке, которая полностью свободна от двусмысленностей, просто из-за неформальной природы естественного языка - и, следовательно, что действительно однозначная спецификация должна включать код, написанный на формально указанном языке. Это известный результат или я что-то упустил?

10 documentation  specifications 

Я один из тех разработчиков, которые думают, что написанный код должен быть понятен и читать как книга. ОДНАКО, при разработке кода библиотеки для использования другими людьми, я стараюсь помещать как можно больше документации в файлы заголовков; что поднимает вопрос: стоит ли документировать методы, которые не являются публичными, даже времени? Они …

10 c++  documentation 

Трудно сказать, что здесь спрашивают. Этот вопрос является двусмысленным, расплывчатым, неполным, чрезмерно широким или риторическим, и на него нельзя дать разумный ответ в его нынешней форме. Чтобы получить разъяснения по этому вопросу, чтобы его можно было снова открыть, посетите справочный центр . Закрыто 8 лет назад . Мне нравятся маленькие …

10 agile  documentation  methodology 

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

10 design  documentation  users 

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

10 development-process  documentation  source-code 

Я задокументировал свой код для doxygen, но я не хочу использовать HTML по умолчанию. Я знаю, что могу настроить его, предоставляя собственные CSS, верхние и нижние колонтитулы и т. Д. (Как это делает GNOME), и как я могу добавить общий PHP-код в файлы и сказать, чтобы он сохранялся как .php, …

10 documentation  templates  documentation-generation 

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

10 java  php  algorithms  documentation  sql 

У нас есть много документов, связанных с нашей разработкой программного обеспечения. К ним относятся такие вещи, как требования, проектные документы, внешние PDF-файлы, файлы клиентов, инструкции по тестированию и т. Д. В настоящее время эти документы разбросаны повсюду (вики, «какое-то место в сети», жесткий диск локальных разработчиков (!), и даже в …

10 version-control  documentation 

Рассматривая реализацию функции другого программиста для вычисления CDF нормального распределения , я предложил либо заменить всю реализацию встроенными функциями Python, либо использовать SciPy, общую научную библиотеку. Другой программист отметил, что ни math.erfc()не scipy.stats.norm.cdf()дает никаких точных гарантий в своей документации. Поэтому я должен быть более осторожным при замене алгоритма аппроксимации (который …

9 documentation  math  floating-point  numeric-precision 

Часто я решаю ошибки, находя ответ по переполнению стека. Это плохая практика - добавлять фрагмент того, почему я сделал то, что я сделал, а затем добавить ссылку на статью или страницу из Интернета?

9 documentation 

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

9 java  documentation  javadocs 

Это относится к обсуждению в ответе и комментариям к этому вопросу: что происходит с отвращением к документации в отрасли? , В ответе утверждалось, что «код не может лгать» и, следовательно, должен быть местом для перехода, а не документацией. В нескольких комментариях указывалось, что «код может лгать». С обеих сторон есть …

9 documentation 

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

9 documentation  comments 

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

9 documentation  business-rules