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

Одной из основных целей компаний-разработчиков программного обеспечения является увеличение их шинного фактора. Об этом также говорится в докладе, организованном Google . Это означает, что вы должны кодировать и документировать все так, чтобы, если завтра вас переедет автобус, проект все еще может продолжаться. Другими словами, вы должны легко заменить себя другим …

48 documentation  clean-code 

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

47 documentation  teamwork 

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

43 documentation  teamwork  team  code-reuse 

Я пишу (надеюсь) полезные комментарии в кодовой (C ++) документации типа: The reason we are doing this is... Причина, по которой я использую «мы» вместо «я», заключается в том, что я много пишу в академической среде, где «мы» часто предпочитают. Итак, вот вопрос. Есть ли веская причина отдавать предпочтение одному …

41 documentation 

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

39 design  object-oriented  documentation  performance 

Каковы технические характеристики? Являются ли они такими же, как проектные документы. Если нет, то в чем разница и некоторые примеры?

38 documentation  specifications 

Мы пытаемся переместить процесс документирования нашего проекта из Документов Google в набор автономных репозиториев Git. Текстовые документы достаточно дружественны к Git, так как обычно нам не нужно никакого необычного форматирования, мы просто конвертируем все, скажем, в multimarkdown с возможностью встраивания LaTeX для сложных случаев. Но электронные таблицы - это совсем …

35 version-control  documentation  tools  linux 

Моя компания стремится улучшить управление данными своих исследований рынка. Текущий стиль управления данными: "Эй, Джимбо, где эта фотография нашего WhatZit 2.0? «Да, я помню это письмо об этой компании от этого парня, дай мне несколько минут, чтобы найти в моем Outlook» «у кого самая новая копия каталога продукции Важного конкурента? …

35 documentation  cms  wiki 

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

35 documentation  language-agnostic  methodology 

В настоящее время я стажер в правительственном подрядчике, и у меня появляется (неприятно неизбежное) ощущение, что Word является стандартом де-факто в процессе разработки программного обеспечения. Его двоичный формат очень затрудняет совместную работу с документами так, как я привык работать на основе кода. Использование простой текстовой разметки (с такими языками, как …

33 development-process  documentation 

Когда люди начали писать файлы Readme? Кажется, что почти во всех программах есть этот файл, независимо от формата. Есть ли документированное первое использование этого документа?

32 documentation  terminology  history 

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

26 programming-practices  development-process  documentation  source-code  sdlc 

На моем рабочем месте мы сталкиваемся с проблемой в том смысле, что «проворный» слишком часто означает «расплывчатые требования, плохие критерии принятия, удача!» Мы пытаемся решить эту проблему как общее улучшение. Поэтому, как часть этого, я предлагаю, чтобы мы сгенерировали проектные документы, которые, помимо уровня пользовательской истории, точно отражали результаты предварительных …

25 design  agile  documentation 

Разработка, основанная на поведении, с ее символическим синтаксисом сценариев «задано, когда», в последнее время получила широкое распространение из-за его возможного использования в качестве граничного объекта для оценки функциональности программного обеспечения. Я , безусловно , согласен , что Огурец , или какой бы ни функция определения сценария вы предпочитаете, является бизнес …

24 documentation  bdd  documentation-generation  business-rules 

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

23 documentation