Каковы технические характеристики? Являются ли они такими же, как проектные документы. Если нет, то в чем разница и некоторые
Я работаю как часть команды над существующим приложением, которое не имеет встроенной документации и не имеет технической документации. Поскольку я работал над различными отчетами об ошибках в приложении, я написал для себя своего рода цепочку крошек - номера ошибок в разных местах, чтобы следующий...
Мы пытаемся переместить процесс документирования нашего проекта из Документов Google в набор автономных репозиториев Git. Текстовые документы достаточно дружественны к Git, так как обычно нам не нужно никакого необычного форматирования, мы просто конвертируем все, скажем, в multimarkdown с...
Моя компания стремится улучшить управление данными своих исследований рынка. Текущий стиль управления данными: "Эй, Джимбо, где эта фотография нашего WhatZit 2.0? «Да, я помню это письмо об этой компании от этого парня, дай мне несколько минут, чтобы найти в моем Outlook» «у кого самая новая копия...
В настоящее время я стажер в правительственном подрядчике, и у меня появляется (неприятно неизбежное) ощущение, что Word является стандартом де-факто в процессе разработки программного обеспечения. Его двоичный формат очень затрудняет совместную работу с документами так, как я привык работать на...
Когда люди начали писать файлы Readme? Кажется, что почти во всех программах есть этот файл, независимо от формата. Есть ли документированное первое использование этого...
Есть несколько хороших примеров хорошо документированного кода, такого как Java API. Но большая часть кода в публичных проектах, таких как git и внутренние проекты компаний, плохо документирована и не очень удобна для новичков. На всех этапах разработки программного обеспечения мне приходилось...
На моем рабочем месте мы сталкиваемся с проблемой в том смысле, что «проворный» слишком часто означает «расплывчатые требования, плохие критерии принятия, удача!» Мы пытаемся решить эту проблему как общее улучшение. Поэтому, как часть этого, я предлагаю, чтобы мы сгенерировали проектные документы,...
Разработка, основанная на поведении, с ее символическим синтаксисом сценариев «задано, когда», в последнее время получила широкое распространение из-за его возможного использования в качестве граничного объекта для оценки функциональности программного обеспечения. Я , безусловно , согласен , что...
Я работаю над проектом уже пару лет, и я начинаю собирать приличную базу пользователей. Я создал страницу проекта с некоторой базовой документацией, но на данный момент это не намного больше, чем FAQ. Я знаю, что мне нужно улучшить его, чтобы он был более информативным как для новых, так и для...
Почему в документации на некоторых языках написано «эквивалентно», а не «есть»? Например, документы Python говорят itertools.chain(*iterables) ... Эквивалентно : def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element Или эта ссылка на C...
Закрыто . Этот вопрос должен быть более сфокусированным . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он был сосредоточен только на одной проблеме, отредактировав этот пост . Закрыто в прошлом году . Я хочу документировать свой код так, чтобы...
Я не могу сосчитать, сколько раз я прочитал утверждения в духе «модульные тесты являются очень важным источником документации тестируемого кода». Я не отрицаю, что они правдивы. Но лично я никогда не использовал их в качестве документации, никогда. Для типичных структур, которые я использую,...
Кажется немного спорным предметом документирования всего, включая синтаксис «JavaBean» методов получения и установки полей: люди говорят, что это бесполезно длинный и повторяющийся разрыв DRY (не повторяйте себя) , что соглашение об именах должно объяснять все , и это загромождает код /...
В настоящее время мы пишем функциональные и технические спецификации в формате двух столбцов; Краткое предложение и технические детали. Детали часто относятся к приложению со схемами, схемами дизайна и т. Д. Однако я борюсь с тем, в каком времени писать это: С прошедшим временем, как будто работа...
Итак, у нас есть такой интерфейс /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary>...
Фон: мои сотрудники и я пишем статью для академического журнала. В ходе нашего исследования мы написали программу моделирования на Java. Мы хотим сделать программу симуляции свободно доступной для использования другими. Мы решили разместить код в репозитории GitHub. Чтобы другим было легко...
Иногда, хотя и не часто, мне приходится включать математическую логику в мой код. Используемые концепции в основном очень просты, но результирующий код не таков - множество переменных с неясной целью и некоторые операции с не столь очевидным намерением. Я не имею в виду , что код не читается или...
Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 6 лет назад . Проведя более года, работая над проектом социальной сети для меня с...
Недавно я работал над рефакторингом частей базы кода, с которыми я сейчас работаю, - не только для того, чтобы лучше понять это, но и для того, чтобы облегчить работу тех, кто работает над кодом. Я склонен полагать, что самодокументированный код - это хорошо . Я просто думаю, что это чище, и если...