Оформление проектной документации гост 2019: Библиотека государственных стандартов

С января 2015 года на территории России для добровольного применения вводится в действие ряд стандартов на проектную документацию

• ГОСТ 21.001-2013 «Система проектной документации для строительства. Общие положения» устанавливает основные положения комплекса стандартов Системы проектной документации для строительства (СПДС) и определяет назначение стандартов СПДС, структуру комплекса стандартов СПДС, порядок их обозначения и применения.
• ГОСТ 21.110-2013 «Система проектной документации для строительства. Спецификация оборудования, изделий и материалов» устанавливает форму и общие правила выполнения спецификации оборудования, изделий и материалов в составе рабочей документации для строительства объектов различного назначения.
• ГОСТ 21.114-2013 «Система проектной документации для строительства. Правила выполнения эскизных чертежей общих видов нетиповых изделий» устанавливает основные требования к разработке эскизных чертежей общих видов нетиповых изделий (конструкций, устройств, монтажных блоков), выполняемых к основным комплектам рабочих чертежей для строительства объектов различного назначения.
• ГОСТ 21.207-2013 «Система проектной документации для строительства. Условные графические обозначения на чертежах автомобильных дорог» устанавливает основные условные графические обозначения и упрощенные изображения, применяемые на чертежах автомобильных дорог различного назначения.
• ГОСТ 21.302-2013 «Система проектной документации для строительства. Условные графические обозначения в документации по инженерно-геологическим изысканиям» устанавливает условные графические обозначения видов грунтов, их литологических особенностей, особенностей залегания слоев грунтов, элементов геоморфологии, геокриологии, гидрогеологии, применяемые на инженерно-геологических картах, разрезах, колонках. Стандарт распространяется на проектную и рабочую документацию для строительства предприятий, зданий и сооружений различного назначения.
• ГОСТ 21.701-2013 «Система проектной документации для строительства. Правила выполнения рабочей документации автомобильных дорог» устанавливает состав и правила оформления рабочей документации на строительство, реконструкцию и капитальный ремонт автомобильных дорог различного назначения (автомобильные дороги общего и необщего пользования).
• ГОСТ 21.702-2013 «Система проектной документации для строительства. Правила выполнения рабочей документации железнодорожных путей» устанавливает состав и правила оформления рабочей документации на строительство новых и реконструируемых железнодорожных путей различного назначения (общего пользования, необщего пользования и технологических путей).

Разработчик стандартов – Технический комитет по стандартизации 465 «Строительство».

Знаете ли вы 7 ключей к правильной работе?

Когда я обучаю менеджеров проектов, я слышу, что больше всего беспокоит проектная документация. Чувство бюрократии никому не нравится. Но мы знаем, что необходим некоторый учет.

Итак, вот тема, которая заставит сердце каждого менеджера проекта биться быстрее… Документация по проекту. Вы знаете, что вам это нужно, но вряд ли это любимый!

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

Вот почему в этой статье мы рассмотрим все, о чем вам нужно подумать. И каждому большому документу нужно оглавление…

Содержание: 7 ключей к хорошей проектной документации

1. Понять, почему проектная документация важна
2. Признать роль проектной документации в управлении проектом
3. Знайте, какую проектную документацию использовать
4. Примените основы для правильного составления проектной документации
5. Хорошо отформатируйте проектную документацию
6. Управляйте строгим контролем версий
7. План хорошего управления документами

Итак, приступим!

Приблизительное время прочтения: 24 минуты

1.Понять, почему проектная документация важна

Поскольку это никому не нравится, первый вопрос, который нам нужно решить, – это

«Почему следует отдавать приоритет проектной документации?»

И простой ответ таков:

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

1. Все дело в менеджменте

Многие из наших проектных документов будут подсказывать или направлять ваши действия по проекту. Примеры подсказок к действию включают:

• контрольные списки
• реестры рисков
• тестовые документы

Примеры руководств к действию включают

2. Надлежащее управление требует тщательного аудита

Часть роли вашей проектной документации состоит в том, чтобы фиксировать то, что вы делаете, и причины ваших решений.Это позволяет объективным экспертам оценить соответствие и извлечь уроки из ваших решений и опыта.

3. Связь – это хорошо

Ценная роль некоторых из ваших документов будет заключаться в том, чтобы информировать членов команды, заинтересованные стороны и уровни управления вашим проектом о том, что вы делаете.

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

4. Подготовка проектной документации стимулирует творческое мышление

Иногда лучший способ продумать проблему или решение новаторски – это научить себя создавать документ. Структура, которую этот процесс может придать вашему мышлению, часто открывает новые идеи.

5. Хороший документ помогает структурировать аргумент

Точно так же структурирование хорошего документа заставляет вас тщательно продумать дело, которое вам нужно представить. Адвокация – это часть вашей роли.Иногда вам нужно будет убедить заинтересованные стороны, группы управления проектом и даже членов команды. Созданный вами документ может оказаться ценным подспорьем. Но зачастую настоящая ценность заключается в его приготовлении.

Вы менеджер проекта или обезьяна проекта?

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

Итак, у меня есть простое руководство, которое напомнит вам о том, что нужно быть менеджером проекта, и поможет избежать риска стать Project Monkey.

Project Monkey
«Обезьяна видит: обезьяна делает» – это идиома, которая предполагает, что обезьяны не думают, прежде чем действовать.

Обезьяна проекта увидит шаблон и завершит его. Менеджер проекта спросит, помогут ли документы:

• эффективно выполнить проект в соответствии со спецификациями, бюджетом и графиком, или
• сделать это прозрачно и подотчетно

Если этого не произойдет, менеджер проекта передаст документы и займется чем-то полезным .

2. Признать роль проектной документации в управлении проектом

Как менеджер проекта, вы знаете ценность планов проектов и средств управления проектами.

• Планы проектов говорят нам, как мы собираемся что-то делать
• Средства управления проектами сообщаем нам, как мы будем придерживаться плана, вернуться к плану, если мы отступим, и поддерживать подотчетность

Управление документами и контроль версий – это два основных элемента управления проектом.

Инвестируйте время на раннем этапе своего проекта

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

• Некоторые из них начнутся на этапе определения , но
• Вы создадите большую часть своей документации на этапе планирования .

Создание многоразового набора хорошо продуманной проектной документации

Если хорошая документация – это разумное вложение, почему бы не подумать о супер-калибровке?

Не просто создавайте нужные документы, а проектируйте их так, чтобы вы могли использовать их в следующий раз.

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

Получите собственную библиотеку шаблонов управления проектами

Если у вас нет PMO, и у вас нет времени создавать шаблоны для всей документации по управлению проектами, которая вам понадобится, взгляните на наш.

Роль PMO

Одна из ролей PMO (Project, Programme or Portfolio Management Office) – создавать и поддерживать набор базовой документации по управлению проектами, которую менеджеры проектов могут использовать.Действительно, многие PMO рассматривают проектную документацию как основную часть своей деятельности. Они будут:

• Создание и поддержка библиотеки шаблонов и стандартов документации
• Сыграйте роль в проверке и авторизации проектных документов
• Поддерживайте файловую структуру и архив документов
• Установите процедуры для таких вещей, как контроль версий, архивирование, удаление

Не знаете, что такое PMO?

Посмотрите это короткое видео…

3.Знайте, какую проектную документацию использовать

Никому не нравится ощущение нагруженности бюрократии. Но все мы знаем, что важно вести записи. Итак, какой объем проектной документации нужен? И в чем секрет избавления от лишних отчетов и заполнения форм?

Я предлагаю:

1. Пять жизненно важных форм документации проекта
2. И пять наиболее ценных, из другой документации вы могли бы рассмотреть

Видео или текст?

Если вы читаете эту статью, вы, вероятно, предпочитаете читать, но я также снял видео, в котором обсуждаются «Ключевые результаты управления проектами» …

Правильная подготовка проектной документации – это все дело баланса

Прежде чем мы рассмотрим мои предложения, давайте подумаем, как я их разработал.Баланс, который вам нужно достичь, находится в диапазоне:

• С одной стороны…
  Надлежащее управление, прозрачность, подотчетность и контрольный журнал
• И, с другой стороны…
  Скорость выполнения, сокращение усилий, сосредоточенность на действиях и эффективность

У меня есть простой подход, который стал бы хорошим дополнением к моему списку правил управления проектами.

Добавляйте документацию только в том случае, если она поддерживает хорошее управление или облегчает вашу работу в качестве менеджера проекта.

Это основной. Как руководитель проекта, вы несете одну основную ответственность:

Реализуйте свой проект в соответствии с правилами, установленными вашей организацией.

Значит, ваша документация по проекту должна это поддерживать. Если это не помогает, значит, это просто мешает вам!

В конце концов, ваша работа проста: реализовать свой проект. Следовательно, вы захотите сделать все, что поможет вам улучшить результаты управления проектами.

Большой вопрос:

Вкратце, это вопрос, на который вы хотите получить ответ. Так что позвольте мне ответить…

Предполагая, что вы выполняете проект для кого-то другого (вашей организации или клиента), я думаю, вы должны предоставить эти пять документов, в том или ином виде:

1. Определение проекта
2. Бюджет или бизнес-модель
3. План
4. Реестр рисков
5. Документ передачи / утверждения

Они довольно равномерно распределены по восьми основным этапам управления проектом.

Обратите внимание на предписания

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

Итак, что я подразумеваю под «некоторая форма…» для каждого из этих проектных документов. И как мне оправдать свою позицию? Давайте рассмотрим каждый по очереди.

Определение проекта / Устав

Первый документ, который вы создаете, должен описать, чем является ваш проект, а что нет.Также необходимо установить широкую причину, по которой нужно делать проект.

Без этого документа у спонсора нет оснований сказать да или нет для дальнейшего подробного исследования. И после запуска это документ, который сообщает вам, вашей команде и вашим заинтересованным сторонам, что вы собираетесь делать, а не делать.

Узнать больше об определении / хартии проекта

Бизнес-модель / бюджет

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

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

Подробнее о бизнес-модели / бюджете

План проекта / Программа

Для некоторых план проекта – это проектная документация.Старая поговорка о том, что «Неудача в плане – значит планирование провалиться», часто бывает верной. Итак, если у вас есть план, почему бы не задокументировать его?

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

Подробнее о планировании проекта

Реестр рисков

Вы тратите чужие деньги.И вы ставите под угрозу их репутацию. Следовательно, вам необходимо продемонстрировать, что вы управляете соответствующими рисками.

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

Подробнее о реестре рисков

Передача / передача

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

Подробнее о сдаче проекта

Если это минимум, что еще важно?

Наши различные курсы поставляются с широким спектром шаблонов проектной документации, чтобы помочь нашим студентам быстро начать работу.

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

Какими будут мои следующие приоритеты, когда у меня будут первые пять пунктов? Почти наверняка это будут эти пятеро…

План взаимодействия с заинтересованными сторонами

Простой документ, в котором указывается, кто мои заинтересованные стороны и как я планирую взаимодействовать с ними в позитивном ключе.

Подробнее о взаимодействии с заинтересованными сторонами

Ресурсный план

Это будет больше, чем просто план развертывания.В нем будет описано, какие ресурсы вам нужны, их необходимые качества (или характеристики) и как вы планируете их приобретать.

Подробнее о плане обеспечения ресурсов

Список результатов

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

Подробнее о результатах проекта

Отчеты о состоянии

Когда ваш проект уже запущен, люди должны знать, как у вас дела. Это важно для хорошего управления – надзора и принятия решений. Это также ключевая часть обеспечения прозрачности и контрольного следа.

И, наконец, это средство общения с членами команды и заинтересованными сторонами.

Подробнее об отчетах о статусе

Обзор извлеченных уроков

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

Следовательно, найдите время, чтобы проанализировать, чему команда научилась вместе, и задокументировать это. Это идет не столько на пользу организации, сколько для самих членов команды. Часто это будет последняя часть проектной документации, которую вы создадите для конкретного проекта.

Но, конечно, если вы сможете сделать документ об извлеченных уроках ценным для вашей организации… Тем лучше!

Что вы думаете?

Какие формы проектной документации вы считаете наиболее важными? Дайте нам знать в комментариях ниже.

4. Основные принципы подготовки проектной документации

Остальная часть этой статьи содержит важные детали. Но если вы нетерпеливый читатель, которому просто нужны абсолютные основы, вот они, в три этапа.

Шаг 1: Проектная документация – промежуточные результаты

Проектная документация – это промежуточные результаты. А результаты, говоря прямо, – это то, за что вам платят. Итак, вам необходимо:

• указать,
• график и
• план их производства

Это означает выделение времени и ресурсов, которые вам понадобятся.А это означает, что вам нужно будет договориться о том времени и этих ресурсах, когда вы оцениваете объем своего проекта.

Убедитесь, что вы поместили задачи по созданию проектной документации в исходное описание объема работ. Затем встроите его в структуру декомпозиции работы позже.

Также поможет, если учесть, какие проектные документы будут:

• Предварительно
  Вы будете продолжать анализировать и развивать их на протяжении всего проекта (как планы заинтересованных сторон)
• Фиксированные
  Или в основном исправленные.Вы разработаете их один раз и доработаете их, если события сделают их более неадекватными (например, процедура контроля изменений).

Шаг 2. Используйте документы вашего проекта

Это должно быть очевидно. Но я видел несколько грубых грехов против приоритета полезности.

иногда говорят, создавая все необходимые документы для своих проектов. Но потом они забывают о них и реализуют проект «Инстинкт кишки» . Или, точнее говоря, они придумывают (снова) по мере продвижения.

Это не только серьезная угроза надлежащему управлению, но и подрывает уверенность команды и заинтересованных сторон в том, что происходит.

Но хуже того, это просто неэффективно. Это создает бесполезные усилия и ошибки.

Шаг 3. Сделайте вашу документацию доступной

Если ваша команда собирается использовать документацию, которую она создает, она должна иметь к ней доступ. И добиться этого легко и быстро.

Итак, убедитесь, что все ваши документы полностью доступны для членов проектной группы.Но в то же время вы также должны убедиться, что они в безопасности, охраняя:

• конфиденциальность
• защита данных
• несанкционированное редактирование.

5. Хорошо отформатируйте проектную документацию

Возможно, самая важная характеристика хорошей проектной документации – последовательность.

Да, это приятно (даже очень желательно), чтобы документы имели единообразный внешний вид. Но здесь важно то, как последовательность может ускорить поиск информации людьми, поскольку они знают и распознают формат.

Это в равной степени относится к макету документов – где можно найти важную информацию – и к форматам файлов, которые вы используете для электронных версий.

Читаемость очень важна

Мы пишем документы для общения с другими людьми. Так что никогда не недооценивайте ценность четкого письма.

Мои главные советы (из моего живого курса: «Убедительные, убедительные и мощные отчеты» ) заключаются в том, чтобы создавать ваши документы:

1. Принуждение к чтению
   Сделайте это, создав простую структуру и предлагая вашим читателям частые указатели, чтобы они могли легко следовать вашей логике.
2. Легко читать , используя простой, прямой язык.
   Если вам необходимо использовать жаргон или аббревиатуры, всегда объясняйте их, если вы не на 100 процентов уверены, что каждый читатель поймет, что они означают. Даже тогда, когда вы впервые используете аббревиатуры, пишите акронимы полностью
3. Приятно читать
   Используйте аккуратное форматирование и много пустого пространства
4. Как можно проще для понимания
   Вы можете добиться этого с помощью иллюстраций, диаграммы, графики и таблицы, чтобы дополнить ваш текст
5. Убедительно
   Сделайте это, отделив факты от мнений и признав необходимость установления доверия и достоверности перед
6. Запоминающийся
   Сделайте ключевую информацию легко запоминающейся, подчеркивая ключевые идеи несколько раз, разными способами
7. Мощный
   Дайте вашим документам возможность побуждать к действиям, четко обозначив решения или действия, которые должен предпринять ваш читатель

Презентация также важна

Подумайте о макете и форматировании ваших документов.Хорошей отправной точкой является руководство по корпоративному стилю, если оно у вас есть. В противном случае ищите самые лучшие и четкие внутренние документы и адаптируйте стиль, который они используют.

Первая страница или титульный лист – важная часть каждого проектного документа. На нем должно быть:

• Название проекта
• Имена менеджера проекта и спонсора
• Название документа
• Версия и дата
• Автор документа

Отличный способ убедиться, что люди каждый раз понимают это правильно, – это установить для людей последовательный набор шаблонов использовать.

Получите собственную библиотеку шаблонов управления проектами

Если у вас нет PMO, и у вас нет времени создавать шаблоны для всей документации по управлению проектами, которая вам понадобится, взгляните на наш.

6. Управление строгим контролем версий

Проекты постоянно меняются. Иногда так поступают и люди. Несмотря на весь контроль, который вы стремитесь установить, они могут быть заняты, спешат и временами даже хаотичны. И, конечно, ваши документы тоже будут меняться – иногда часто.

Поэтому важно, чтобы люди знали, что они работают, исходя из правильных документов.

Если член команды проекта обновит документ, не сообщая об этом людям, могут возникнуть катастрофы. Два человека могут работать с разными версиями одного и того же документа и выполнять разную и непоследовательную работу. В лучшем случае – неэффективность и потраченные впустую усилия. В худшем случае, как в случае с Mars Climate Orbiter НАСА, это фатальная ошибка, которая приведет к полному провалу проекта.

Что такое система контроля версий

Контроль версий – это дисциплина, которая обеспечивает три вещи:

1. Есть центральный реестр, который позволяет любому пользователю узнать статус любого документа.Важно отметить, что пользователи могут установить, какая версия является текущей и что они, следовательно, могут полагаться на
2. Каждый документ содержит недвусмысленную информацию, которая позволяет пользователям узнать его статус
3. Пользователи могут отслеживать изменения от одной версии к другой и так быстро понимать различия что новая версия представляет

Как заставить работать контроль версий

Степень и строгость вашего контроля версий будут зависеть от:

1. Культура вашей организации
2. Масштаб, риск и чувствительность вашего проекта

Но существенными элементами являются:

• Уникальные номера версий
  В каждом документе четко указаны дата и номер версии (или редакции).Я предпочитаю, чтобы это отображалось на каждой странице – обычно в нижнем колонтитуле или верхнем колонтитуле
• Простая система нумерации версий
  Система нумерации версий должна быть простой, но понятной
  В случае сомнений используйте упрощенную форму управления версиями программного обеспечения:

• В каждом документе должна быть таблица управления версиями.
  В ней будут записываться записи версий, основные изменения, вносимые каждым из них, и дата авторизации.
  В идеале, в нем также будут записываться авторы и авторизаторы обновлений.
• Обзор версий и Авторизация
  Разработайте процедуру просмотра и авторизации новых версий.Вы адаптируете процедуры подписания к потребностям вашего корпоративного управления.
• Центральный реестр документов и версий
  Это позволяет пользователям легко проверять, какая версия того или иного документа является последней.
• Автоматизировано, если возможно
  Существует программное обеспечение, которое может автоматизировать хранение, запись и маркировку версий документов. Но, как минимум, вы должны заложить основы в свои шаблоны документов.

7. План хорошего управления документами

Ваша проектная документация ценна.Итак, вы должны относиться к своим документам как к активам, о которых вам нужно позаботиться. Мы посмотрим на это с двух сторон:

1. Хранение… а не
2. Надежное хранение

1. Доступность, хранение, архивирование, удаление

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

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

Вам нужен контроллер документов?

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

Доступное хранилище

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

Для наименования я предлагаю имя документа, состоящее из трех частей:

1. Одно или два слова, которые обозначают классификацию документа – возможно, перед ним стоит структурная декомпозиция (код WBS).
2. Длинное имя, позволяющее четко понять, что это за документ.
3. Номер версии

Вот пример:

09-Testing – Пользовательские протоколы приемочных испытаний – v01.03

Разрозненные документы

Все мы знакомы с принципами работы крупных корпораций и государственных органов. Вы узнаете это:

• Контракты хранятся в Legal
• Соглашения об уровне обслуживания подрядчиков и тендерная документация хранятся в Закупках
• Утверждения бюджета хранятся в Финансах
• Сетевые диаграммы хранятся в IT
• … и так далее.

Есть некоторые организации, которые, я не думаю, скоро решат эту проблему!

Как менеджеру проекта, вам необходим реестр связанных с проектом документов, которые хранятся вне прямого контроля вашей проектной группы.В идеале для каждого из них должно быть указано название сообщения и текущий постодержатель, чтобы пользователи могли получить документы как можно быстрее.

Что архивировать

При архивировании документов следует рассмотреть один вопрос: архивировать ли все версии, все основные версии или просто окончательную версию. Я не могу вам предложить универсального правильного ответа. Рассмотрим:

• Характер и продолжительность вашего проекта
• Политика вашей организации
• Характер документов, которые вы рассматриваете

Когда архивировать

Кому потребуется доступ к проектной документации после завершения вашего проекта? И как долго? Подумайте, будут ли продолжаться процессы управления – возможно, в форме обзоров реализации долгосрочных выгод.А как насчет будущих менеджеров проектов, которым, возможно, потребуется поучиться на вашем проекте?

Когда выбрасывать вещи

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

2. Безопасность документов

Последний набор соображений относится к безопасности документов и данных.

У вас может быть конфиденциальная информация, касающаяся:

• сотрудников и их эффективность
• подрядчики и консультанты и их коммерческие условия
• поставщики и их цены
• стратегические планы вашей организации

Итак, вам нужно задать четыре важных вопроса и ответить на них:

1. Что вы будете делать, чтобы обеспечить целостность версии?
2. Как вы обеспечите физическую безопасность документов?
3. Каковы ваши процедуры защиты данных?
4. Как вы ограничите доступ к конфиденциальной документации?

Подробнее об управлении проектной документацией…

Взгляните на нашу статью «Управление документацией проекта: как организовать и управлять информацией о проекте» .

Что вы посоветуете по управлению проектной документацией?

Приходилось ли вам вести проектную документацию? Если да, расскажите, какой совет вы могли бы дать нашему сообществу. И если вам еще не приходилось этого делать, какие у вас есть вопросы, на которые мы не ответили в этой статье?

Как это:

Нравится Загрузка …

Документы, которые вы ДОЛЖНЫ создавать для любого проекта

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

Следуя моему подходу и выполняя домашнюю работу (в основном проясняя цель проекта), вы больше не застрянете во время запуска проекта.

От подавленности к ясности

Мы застреваем, когда уделяем слишком много внимания одновременно:

• Разбираемся, как приступить к проекту
• Получение оценок от членов команды
• Привлечение заинтересованных сторон
• Настройка бюджета
• Настройка общего доступа к документам
• Как заставить новый ноутбук работать
• .. ДОБАВИТЬ 100 ДРУГИХ ВЕЩЕЙ, КОТОРЫЕ НАЧИНАЮТ ЗАБОТАТЬ

Происходит то, что вы полностью подавлены и не двигаетесь вперед.

И я не хочу, чтобы это случилось с тобой.

Вот как можно избежать перегруженности новыми проектами:

Задайте себе этот вопрос

Вместо того, чтобы начинать с пустой страницы, задайте себе вопрос:

Какие документы мне нужны для подготовки моего нового проекта?

Так ваша работа станет намного проще.

Почему нужно начинать с документов

Когда вы сосредотачиваетесь на документах, которые необходимо создать, у вас есть пошаговый процесс настройки проекта. Создание проекта похоже на рисование по номерам.

И даже нарисовать Мона Лизу можно, когда все, что вам нужно сделать, это заполнить узор.

Посмотрите на это:

Я не говорю все станет легко. Ведение проекта остается тяжелой работой.Но, по крайней мере, теперь у вас есть путь, который приведет вас к полному и последовательному плану действий.

И все, что вам нужно сделать, это заполнить документы один за другим, пока ваш проект не будет полностью спланирован.

Таким образом можно организовать свой календарь.

Например:

• Сегодня вы пишете устав проекта
• На следующий день вы создаете расписание
• Снова на следующий день вы планируете бюджет
• и т. Д.

После 2-3 недель работы в Word и Excel ваш проект готов к работе!

Письмо значит мышление

Вы знаете, что я нашел наиболее полезным в этом процессе?

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

Просто записав, подумав и уточнив.

Необходимые документы для любого проекта

Вот минимальный набор документов, который вам нужен:

Описание документов

Узнайте, для чего предназначен каждый документ.Я добавил свои шаблоны.

1. Отслеживание действий и проблем

Запишите все действия и проблемы в простой файл Excel. Вот трекер действий, который я использую:

Скачать мой трекер действий для Excel

2. Устав проекта

Устав проекта подобен контракту между вами и клиентом. Он содержит важную информацию о проекте, такую ​​как основные этапы, бюджет, график и общий объем работ в обобщенной форме.

Узнайте, как заполнить устав проекта и загрузить шаблон (по той же ссылке).

Устав проекта обычно создается в тесном сотрудничестве с вашим клиентом. Вы сидите вместе и обсуждаете ожидания, обязанности, важные вехи и другие вещи. Затем вы документируете все в уставе проекта и вносите поправки с учетом отзывов клиентов.

3. Проектная организация

Простая организационная схема всей проектной организации. Он показывает, кто работает в проекте.

Вы уже видели такие организационные диаграммы:

Нужен шаблон? Получите шаблон организационной схемы моего проекта здесь.

4. Роли и обязанности в проекте

Людям нужна ясность в том, что от них ожидается. В противном случае члены команды будут бегать, как цыплята без головы, и проект не продвинется.

Создайте простой PowerPoint с ключевыми ролями и обязанностями. Я рекомендую прочитать мою статью об определении ролей и обязанностей.

После того, как вы определили роли и обязанности, поделитесь информацией на собрании группы или в начале проекта.Недостаточно того, что вы, , знаете, что должны делать члены команды. Вы должны объяснить это своим людям!

5. План проекта

План проекта показывает всем, что и когда нужно делать. Вы можете использовать мой шаблон плана проекта для Excel.

Если вы регулярно составляете план проекта, я рекомендую использовать такой инструмент, как Tom’s Planner – он значительно упрощает построение диаграмм Ганта.

6. Бюджет проекта

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

Файл позволяет вам планировать сметные усилия и затраты , а до отслеживать фактические расходы на ежемесячной основе.

Если вы впервые настраиваете бюджет проекта, прочтите мое практическое руководство по составлению бюджета проекта. В статье показано, как оценить и рассчитать стоимость проекта для каждой категории, от личных усилий до материальных и сервисных сборов и капитальных затрат.

7. Матрица заинтересованных сторон

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

Почему создание обзора – хорошая идея? Вы не хотите упустить в своем проекте никого, кто мог бы сказать в нем свое слово. Кроме того, вы хотите как можно раньше пообщаться с людьми, на которых может повлиять масштаб проекта.

Помните, что заинтересованные стороны могут быть как внутренними, так и внешними (например, правительственные агентства).

Составление матрицы заинтересованных сторон требует времени и небольшой «детективной работы». Вот почему я предлагаю вам следовать моему руководству по проведению анализа заинтересованных сторон.

8. Реестр рисков

Преимущества документально-ориентированного подхода к планированию проектов становятся очевидными, когда мы говорим о создании реестра рисков.

Реестр рисков (или журнал рисков) – это место, где вы записываете наиболее важные риски, с которыми может столкнуться ваш проект.Он не только определяет эти риски, но также требует от вас думать о действиях по их снижению. Действия, которые либо уменьшают негативное влияние риска, либо альтернативные шаги, которые вы могли бы предпринять в случае неудачи вашего первоначального плана (ваш план «Б»).

Следует ли вам вести журнал рисков? Абсолютно! Если у вас еще нет шаблона, получите мой шаблон реестра рисков.

9. Информационный план проекта

Как часто собирается команда проекта? Когда вы отправляете обновления по электронной почте руководству? Что происходит с эскалацией?

Это то, что вы определяете в документе плана коммуникаций по проекту (включая шаблон).

Причина, по которой план коммуникации так важен: как я подчеркивал и в других своих статьях, хорошее общение абсолютно необходимо для успеха вашего проекта:

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

План коммуникации определяет тип и частоту встреч и обновлений по электронной почте и, таким образом, обеспечивает надлежащее сотрудничество и общение в рамках проекта.

10. Описание объема работ (техническое задание)

Этот документ должен включать подробное описание содержания проекта и требований заказчика (что подразумевается под содержанием проекта?).

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

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

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

11. Счетчик запросов на изменение

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

Примеры:

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

Оба примера представляют собой так называемые изменения (или запросы на изменение) к исходной области проекта. Оба они повлияют на стоимость проекта и, возможно, также на сроки.Другими словами: на проект может потребоваться больше времени.

Рекомендуется отслеживать такие изменения в простом трекере изменений . Даже если они маленькие. Это позволяет вам установить формальный и хорошо организованный процесс, в котором каждое изменение проверяется, оценивается (за дополнительную плату) и утверждается.

Никакие изменения не будут забыты, и никто не может винить вас, когда бюджет проекта увеличивается из-за того, что изменение было реализовано. Так что это тоже способ защитить себя.

Для больших изменений я рекомендую вам создать специальную форму запроса на изменение.Это просто подробное описание нового требования.

В моей статье о масштабах проекта вы найдете средство отслеживания изменений Excel, а также мою форму запроса на изменение.

Еще несколько проектных документов, которые я здесь не перечислял

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

• Бизнес-модель: Вы ​​создаете бизнес-модель, чтобы показать, что ваш проект имеет экономические и стратегические преимущества. Для многих проектов это имеет смысл. С другой стороны, многие проекты запускаются без учета экономической выгоды. Они просто запускаются, потому что их нужно завершить. Примером может служить обновление устаревшего ПК или сетевой инфраструктуры компании.
• Отчет о статусе проекта: Каждый использует свой собственный шаблон для сообщения статуса проекта.Я не хотел ограничивать вас в этом отношении. Если вы ищете проверенный шаблон, получите мой шаблон статуса проекта.
• Документ об извлеченных уроках: Это отличная практика – проводить семинар по извлеченным урокам после завершения проекта. Это делает любой будущий проект лучше, потому что вы учитесь на том, что сработало (или что не сработало). Но для самого вашего проекта документ об извлеченных уроках не требуется.

У вас есть вопросы по проектной документации?

Рад помочь вам.Просто разместите свой вопрос в комментариях ниже и ответьте.

Адриан Ноймайер

Привет! Я Адриан, основатель Tactical Project Manager. Я создал сайт, чтобы помочь вам довести ваши проекты до успеха. В прошлом я работал менеджером ИТ-проектов 10 лет.

Еще сообщения

Не пропустите эти другие статьи

Океаны | Очистка океана

ЗАЩИТНОЕ УПЛОТНЕНИЕ

Защита окружающей среды лежит в основе того, что мы делаем.Это движущая сила наших усилий по удалению больших объемов пластикового загрязнения из мирового океана. Таким образом, защита морской жизни была движущей силой номер один, стоящей за нашими технологиями.

В течение 116 дней после первой миссии группа ученых и экспертов провела обширные кампании по мониторингу и наблюдению, чтобы понять любое возможное воздействие Системы 001 на окружающую среду и минимизировать любой потенциальный вред морской жизни. Было выполнено более 1045 часов визуального и акустического мониторинга, и за это время не наблюдалось существенного вмешательства в Систему 001 и экосистему океана и / или морскую жизнь; мы также не наблюдали запутывания или отлова морских животных или охраняемых видов.

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

Мы также провели оценку воздействия на окружающую среду (ОВОС) для Системы 001 через независимое агентство CSA Ocean Sciences, которое не выявило каких-либо серьезных рисков для окружающей среды, связанных с нашим методом.

ВЫЖИТЬ БУРЯ

Поскольку системы очистки предназначены для того, чтобы оставаться на участке в течение длительного времени, важно, чтобы наши системы могли противостоять силам океана. Главный компонент живучести – гибкость. Мы разработали систему, чтобы она была достаточно гибкой, чтобы иметь возможность следовать за волнами, и, поскольку система свободно плавает, она может дрейфовать под воздействием высоких скоростей течения.

Посредством всестороннего тестирования мы стремимся выявить слабые места, прежде чем увеличивать масштабы нашего присутствия в «мусорных пятнах».После запуска и первоначальных тестов с Системой 001 в 2018 году мы запустили Систему 001 / B – более модульную платформу для тестирования модификаций для ускорения по сравнению с замедлением по сравнению с пластиком.

Как писать документацию по разработке программного обеспечения (SDD)

Используете ли вы проектную документацию по программному обеспечению при создании новых продуктов?

Если вы владелец продукта…

И вы готовитесь начать работать с внештатными веб-разработчиками или полноценной командой инженеров.

Для успеха вашего проекта важно, чтобы вы осознавали их важность.

Или, если вы разработчик…

И вы работаете напрямую с клиентами, у которых нет четкого представления о том, чего они хотят.

Надеюсь, вы уже знаете, насколько важную роль играют документы проектирования программного обеспечения (SDD).

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

Теперь разработчик должен взять на себя все обязанности, которые когда-то были распределены между экспертным тестированием, управлением программами и т. Д.

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

Следовательно, приятно, когда владельцы продукта делают часть работы за ногу!

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

Простое управление проектами.

Пишите требования к программному обеспечению, определяйте приоритеты, систематизируйте задачи, получайте информацию о ходе выполнения – все на одной платформе.

Начало работы с документами по разработке программного обеспечения (бесплатный шаблон ниже)

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

Хорошо структурированная документация по разработке программного обеспечения поможет вам сэкономить дни или даже недели потраченного впустую времени.

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

Итак, давайте разберемся, что такое документы по разработке программного обеспечения…

Из этой статьи вы узнаете:

• Важность четкого общения между владельцем продукта и разработчиком.
• Почему документы для разработки программного обеспечения так важны.
• Что должно быть включено в проектную документацию ПО.
• Пример проектной документации программного обеспечения.
• Шаблон документа по разработке программного обеспечения (редактируемый).

Обмен информацией между менеджерами по продуктам и разработчиками

Источник изображения

Возможность эффективного общения с программистами и разработчиками имеет первостепенное значение для успеха вашего проекта.

Вы, наверное, говорите: «Ну да!»

И это справедливо…

Но есть ли у вас прочная основа для этого? Да? Нет? Может быть?

Если вы являетесь владельцем продукта и создаете новое мобильное приложение, задумывались ли вы о том, как эффективно общаться с разработчиками или как вы будете управлять этими отношениями?

Мы точно знаем, что несколько видеочатов в месяц – это верный путь к катастрофе.

Письма вперед и назад со скриншотами и каркасами становятся все ближе к решению, но все еще не приближаются к реальной структуре.

Владельцы продуктов и разработчики должны поддерживать связь друг с другом на каждом этапе проекта.

И у них должны быть четкие цели и задачи на протяжении всего проекта.

Опять же, может быть, этого и не сказано…

Однако дело только в основах, разработчики получат только общее представление о том, что программное обеспечение предназначено для работы, внешнего вида и ощущений, а также того, как оно работает.

И если вы пишете приложение, основанное даже на немного расплывчатых описаниях, у вас практически нет шансов быть удовлетворенным результатами.

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

Команда все еще крайне редко может произвести то, что она намеревалась создать в разумные сроки.

Фактически, менее 1/3 проектов были завершены вовремя в рамках бюджета в прошлом году (Источник: Standish Group).

Именно здесь документы по разработке программного обеспечения привносят столь необходимую структуру в ваш проект и помогают выполнить его вовремя.

«

В первую очередь нужно подготовиться к любому профессиональному проекту с подробными рамками, верно?

Никто не строит небоскребы, просто взрывая их.

Так почему же это не так, когда дело доходит до создания веб-программного обеспечения и мобильных приложений?

Это огромный кусок головоломки, когда речь идет об эффективном общении между менеджерами продукта и разработчиками.

Еще до открытия IDE (интегрированной среды разработки) – будь то Xcode, React.js или Visual Studio – вы и разработчик должны иметь четкие, согласованные цели и задачи.

Эти цели и задачи должны быть установлены в документе спецификации.

В идеале было бы неплохо, если бы владельцы продукта уже написали его, но в вероятном сценарии, когда они этого не сделали, разработчики должны иметь его и отправлять своему клиенту для проверки.

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

Вот что я имею в виду…

Если разработчик отправляет своему клиенту документ со спецификацией, а клиент отвечает…

«У нас нет времени на конструкторскую документацию»

Это шанс разработчика пойти в другом направлении.

Однако не волнуйтесь, документы по разработке программного обеспечения не должны быть длинными.

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

То есть хотя бы минимум.

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

Вот несколько сильных тем для обсуждения:

Что может произойти

• Возникновение споров по поводу того, что было ранее согласовано.
• Ошибочные толкования из-за классического делового мышления и языка инженерного мышления. И что хуже всего,
• Попадается в ситуацию, когда владельцы продуктов должны просить разработчиков предоставить «то, что они действительно просили», не платя за изменения.

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

Продукты должны выходить на рынок быстрее с каждым днем, и ни одна из сторон не хочет сталкиваться с какими-либо препятствиями.

Итак, давайте углубимся в то, что должно быть включено в документацию по разработке программного обеспечения, а затем рассмотрим наш образец шаблона SDD…

На высоком уровне…

Документация по проектированию программного обеспечения должна включать:

• Описание продукта.
• Объем работ, необходимых для завершения проекта.
• И список вех.

Однако на более подробном уровне давайте разберемся в деталях…

A. Пользовательский интерфейс

Компонент пользовательского интерфейса проекта – безусловно, самый сложный раздел проектного документа.

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

Естественно, это приведет к проблемам со связью.

Так что да, создайте эти иллюстрации, но имейте в виду, что вам потребуется добавить некоторый дополнительный контекст, к которому я скоро вернусь.

Проблема здесь в том, что иллюстрации, скорее всего, мало говорят о…

• Анимации
• Состояния управления.
• Что происходит с кнопкой, когда ее нужно вывести из строя?
• Как узнать, должна ли кнопка быть видна конечному пользователю или нет?
• Или как вы в идеале хотите, чтобы конечный пользователь перемещался по приложению?

И это ключевой пример того, как документы проектирования программного обеспечения позволяют сэкономить драгоценное время.

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

Но сначала вам нужно создать эти иллюстрации…

Инструменты для создания каркасов

Вы можете спросить: «Хорошо, а что, если у меня нет графического дизайнера?»

Не волнуйтесь…

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

Это должно включать любые вариации, которые отображаются в представлениях в различных состояниях приложения.

Для протокола, наш любимый инструмент для создания каркасов – Invision. Они классные 🙂

И если вы работаете над двойным приложением, которое должно быть совместимо для разных устройств и размеров экрана, обязательно создайте отдельные каркасы для каждого устройства.

Да, это заноза в _______. 🙂

Но взвесьте стоимость того, что придется переписывать многочасовый код и постоянно менять пользовательский интерфейс, с тем, сколько времени потребуется одному из вас, чтобы создать эти макеты экрана.

Итак, чтобы избежать недопонимания, которое может превратить трехнедельный проект в трехмесячный…

Не торопитесь на начальных этапах разработки пользовательского интерфейса!

Ничего не предполагайте и задавайте друг другу много вопросов.

B. Требования / Обзор системы

В разделе требований документа по дизайну приложения вы предоставите общее описание функциональности, контекста и дизайна проекта.

Чтобы помочь разработчикам лучше понять ваше приложение, вы ответите на такие вопросы, как:

• «Какова основная цель приложения?» И
• «Каковы возможные сценарии и условия отказа?»

Смысл здесь в том, чтобы владелец продукта ответил на эти открытые вопросы как можно лучше, а затем разработчик задавал дополнительные вопросы после получения ответов.

В результате вы значительно снизите риск недопонимания и необходимость написания дополнительного кода.

C. Основные этапы развития

Установка четких контрольных точек для шаблона проектного документа является ключом к полному пониманию масштабов вашего проекта.

Независимо от того, устанавливает ли эти вехи разработчик или владелец продукта, они должны быть как можно более однозначными и согласованными обеими сторонами.

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

Как минимум, контрольные точки должны обеспечивать четкую метрику завершения.

Один совет по установке контрольных точек: постарайтесь, чтобы они были как можно более близкими по продолжительности.

Хорошо, теперь о той части, которую вы все, возможно, пропустили, прежде чем читать все остальное, что я, конечно, не рекомендую!

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

I. Цели и видение

Здесь все, что вы делаете, – это описание проекта и цели SDD.

Это должно включать такие вопросы, как предполагаемая аудитория и какова будет общая цель проекта.

Например: Создайте минимально жизнеспособное мобильное приложение продукта для iOS и Android.

Раздел 1. Бизнес-цели

Раздел 2: Бизнес-потребности

II.Требования / Обзор системы

Обзор системы разбит на две части:

1. Требования пользователя и
2. Функциональные требования

Раздел 1. Требования к пользователю

Раздел 2: Функциональные требования

В разделе «Требования к пользователю» вы могли заметить, что мы настоятельно рекомендуем воспользоваться мощным упражнением – созданием пользовательских историй.

Чтобы узнать больше о пользовательских историях и о том, как их создавать, мне очень нравится это видео на YouTube от CA Technologies:

Кроме того, вот еще несколько вопросов, на которые вы можете ответить в разделе «Обзор системы»:

• Какова основная цель приложения? Как быстро он это делает?
• Каковы возможные сценарии и условия отказа? Как с ними обращаться?
• Какие разовые операции выполняются при первом выполнении, например сразу после установки?
• Если пользователь создает какие-либо записи (например,г., закладки), какие есть ограничения?

III. Пользовательский интерфейс

Для раздела пользовательского интерфейса в спецификации разработки программного обеспечения вам нужно включить каркасы для каждой страницы с подробным описанием следующих…

• Каждый элемент управления, включая состояния (включен / выключен / выделен) и операции.
• Поддерживаемые ориентации и переходы между ними.
• Представляемая функциональность.
• Обработка ошибок.
• Размеры и ограничения.

Это несколько примеров каркаса для приложения iOS, которые точно изображают, как это должно выглядеть…

Кроме того, вот сообщение JustInMind (еще один инструмент для создания каркасов), которое я взял из: 10 вдохновляющих примеров каркасов для Интернета и мобильных устройств

Наконец, если вы не знакомы с инструментами создания каркасов, вот видео о том, как начать работу с таким инструментом, как Invision:

IV.Вехи и приоритеты

Есть хорошая цитата, которую мы в Tara AI хотели бы напоминать себе, которая гласит:

«Если вас не смущает первая версия продукта, значит, вы запустили слишком поздно».

Следовательно, именно здесь в игру вступают приоритезация и установка реалистичных ориентиров для вашего продукта…

Раздел 1: Вехи

Как описано выше, раздел этапов должен включать сроки завершения и ожидаемые результаты.

Например, раздел этапов в шаблоне документа по разработке программного обеспечения может выглядеть так:

1. Фасадное приложение, показывающее экран с временными переходами и примерами изображений / текста.
2. Протокол связи: приложение подключается к сети / серверу
3. Функциональный этап №1: __________
4. Альфа-приложение (с полной функциональностью)
5. Стабильность и оптимизация
6. Релиз бета

Раздел 2: Приоритезация

То, как выглядит и ощущается ваш продукт, так же важно, как и то, что он делает.

Однако вы должны расставить приоритеты по основным функциям, необходимым для создания вашего MVP.

Итак, мы используем матрицу приоритетов, чтобы помочь в этом. Вот как это выглядит…

Приоритезация функций и пользовательских историй поможет вам определить основные функции, необходимые для создания вашего MVP.

Используйте приведенную выше матрицу приоритетов в качестве основы.

И составьте список ваших приоритетов, разбитых на четыре квадранта

1. Включить в MVP
2. Revisit
3. Не включать в MVP
4. Дебаты

«Если вас не смущает первая версия продукта, значит, вы запустили слишком поздно.”

– Рид Хоффман, LinkedIn

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

Мы покрыли:

• Почему совершенно необходимо писать проектную документацию по программному обеспечению.
• Как эффективно общаться с разработчиками.
• Что должно быть включено в проектную документацию ПО. А,
• Предоставляет шаблон документа по разработке программного обеспечения, с которым вы можете начать работу.

Со временем вы захотите сделать этот шаблон своим, внося необходимые корректировки в зависимости от типа проекта, над которым вы работаете.

Следующие шаги

Теперь, когда вы разработали проектную документацию программного обеспечения и готовы приступить к процессу разработки, что дальше?

Вот где мы, Тара AI, вступаем в игру.

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

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

Добро пожаловать в будущее разработки программного обеспечения!

Если вам интересно, что такое «спринт», мы вам поможем: Scrum Framework в Agile Project Management.

Некоммерческая организация обещала сохранить дикую природу. Затем он заработал миллионы, заявив, что может вырубить деревья.

Клегерн сказал, что меры безопасности программы предотвращают проблемы, выявленные CarbonPlan.

Компенсация Калифорнии считается дополнительным сокращением выбросов углерода, поскольку пол служит «консервативной опорой», – сказал Клегерн. Без этого, объяснил он, многие землевладельцы могли бы вести лесозаготовки на еще более низком уровне при отсутствии зачетов.

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

Но суд не вынес независимого решения об эффективности стандарта и «весьма уважительно отнесся к решению агентства», – заявила Алиса Касван, профессор права юридического факультета Университета Сан-Франциско, в электронном письме.

Закон штата Калифорния требует, чтобы правила штата в отношении ограничения выбросов и торговли квотами обеспечивали «реальное, постоянное, поддающееся количественной оценке и проверке» сокращение выбросов «в дополнение к любому другому сокращению выбросов парниковых газов, которое могло бы произойти в противном случае».

«Если есть новая научная информация, которая наводит на серьезные вопросы о целостности взаимозачетов, то, возможно, CARB несет постоянную обязанность учитывать эту информацию и соответствующим образом пересматривать свои протоколы», – сказал Касван. «Агентство обязано выполнять закон, а закон требует дополнительности».

Рецепт

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

Документы по планированию некоммерческой организации подтверждают, что леса, включенные в программу Калифорнии, были защищены задолго до того, как они начали генерировать компенсацию: «Большая часть проектной территории была сохранена и обозначена как леса высокой природоохранной ценности в течение многих лет с целенаправленным управлением, ориентированным на долгое время. термин ценности сохранения природных ресурсов.”

Outer Banks Scenic Byway получает награду

Национальный живописный район Аутер-Бэнкс получил награду 2021 года от Национального фонда живописных дорог.

Одна из восьми национальных живописных улиц, удостоенных этого звания, дорога Аутер-Бэнкс начинается в северной части Аутер-Бэнкс у Вэлебоун-Джанкшн в Нагс-Хеде и следует за 12-й Северной Каролиной на юг через острова Боди и Хаттерас округа Дэр.

Автодорога направляется на юг на пароме Министерства транспорта Северной Каролины из деревни Хаттерас на остров Окракок в округе Гайд.

От Окракока дорога продолжается на пароме на Сидар-Айленд в графство Даун-Ист-Картерет. Дорога заканчивается у реки Норт-Ривер, ее протяженность составляет 138 миль на автомобиле и 25 миль на пароме.

Мелинда Саттон, председатель Национального консультативного комитета по живописным дорогам Аутер-Бэнкс, участвует в проекте с 2011 года.

«Это так удивительно, что мы получили эту награду за благоустройство после того времени, которое мы потратили на выполнение этого проекта.Так много людей принимали участие в этом за эти годы », – сказала она в своем заявлении. «Это прекрасное признание для них и всего региона Внешних банков».

Представители округов Картерет, Гайд и Дэр, а также государства и федеральные партнеры входят в состав консультативного комитета с самого начала проекта. Комитет работал над разработкой графического логотипа переулка под руководством David L. Dahlquist Associates, LLC и Breann Bye + Associates.

С 2013 по 2019 год участники проекта собрали контент и произведения искусства для 18 уличных киосков в точках входа и 21 индивидуальной интерпретирующей выставки в общинах и деревнях, которые теперь размещены в трех округах.

Эти интерпретирующие компоненты, установленные в 2020 году с командой управления проектом и инженеров Albemarle & Associates, Ltd., выделяют исторические, культурные и природные достопримечательности, такие как четыре маяка, национальные берега мыса Хаттерас и мыс Лукаут, а также историю деревни. , рассказы и рецепты.

Консультативный комитет Национальной живописной дороги Аутер-Бэнкс установил партнерские отношения с Федеральным управлением шоссейных дорог, Министерством транспорта Северной Каролины, правительствами графств Дэр, Гайд и Картерет, Службой национальных парков, США.S. Fish and Wildlife Service и около 100 представителей местных сообществ и проезжих частей в этом проекте.

Национальный фонд живописных переулков санкционирует строительство 184 переулков по всей территории Соединенных Штатов, чтобы улучшить впечатления посетителей в их соответствующих районах.

Фонд каждые два года проводит программу Byway Community Awards, чтобы отметить успехи местных жителей, аффилированных сообществ и лидеров. Признание включает статьи в национальных журналах, признание в социальных сетях и рассылку новостей.

Среди других победителей 2021 года – живописная и историческая прибрежная дорога A1A, All-American Road во Флориде, Аппалачская улица в Огайо, Национальная живописная улица Делавэр-Ривер в Нью-Джерси, Национальная живописная улица Lincoln Highway Heritage в Айове, живописная и историческая улица Los Caminos Antiguos в Колорадо – Национальная живописная улица Мохавк-Таупат, в Нью-Йорке и живописная улица Окои, штат Теннесси.

стандартов голанга / макет проекта: Стандартный макет проекта Go

Переводы:

Обзор

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

Если вы пытаетесь изучить Go, или если вы создаете PoC или простой проект для себя, такая схема проекта будет излишним.Вместо этого начните с чего-нибудь действительно простого (одного файла main.go и go.mod более чем достаточно). По мере роста вашего проекта имейте в виду, что важно убедиться, что ваш код хорошо структурирован, иначе вы получите беспорядочный код с множеством скрытых зависимостей и глобальным состоянием. Когда над проектом будет работать больше людей, вам понадобится еще больше структуры. Вот когда важно представить общий способ управления пакетами / библиотеками. Когда у вас есть проект с открытым исходным кодом или когда вы знаете, что другие проекты импортируют код из вашего репозитория проектов, тогда важно иметь частные (также известные как внутренние ) пакеты и код.Клонируйте репозиторий, сохраните то, что вам нужно, а все остальное удалите! То, что оно есть, не означает, что вам нужно использовать все это. Ни один из этих шаблонов не используется в каждом отдельном проекте. Даже образец поставщика не универсален.

With Go 1.14 Модули Go , наконец, готовы к производству. Используйте модули Go , если у вас нет особой причины не использовать их, и если да, то вам не нужно беспокоиться о $ GOPATH и о том, где вы разместите свой проект. Базовый go.mod в репозитории предполагает, что ваш проект размещен на GitHub, но это не обязательно. Путь к модулю может быть любым, хотя первый компонент пути к модулю должен иметь точку в своем имени (текущая версия Go больше не применяет его, но если вы используете немного более старые версии, не удивляйтесь, если ваши сборки завершатся ошибкой без Это). См. Проблемы 37554 и 32819 , если вы хотите узнать об этом больше.

Этот макет проекта намеренно общий и не пытается навязывать определенную структуру пакета Go.

Это усилия сообщества. Откройте проблему, если вы видите новый шаблон или считаете, что один из существующих шаблонов нуждается в обновлении.

Если вам нужна помощь с именованием, форматированием и стилем, начните с запуска gofmt и golint . Также не забудьте прочитать эти руководящие принципы и рекомендации по стилю кода Go:

См. Go Project Layout для получения дополнительной справочной информации.

Подробнее об именовании и организации пакетов, а также других рекомендациях по структуре кода:

Сообщение в Китае о руководящих принципах пакетно-ориентированного проектирования и уровне архитектуры

Каталоги Go

Основные приложения для этого проекта.

Имя каталога для каждого приложения должно совпадать с именем исполняемого файла, который вы хотите создать (например, / cmd / myapp ).

Не помещайте много кода в каталог приложения. Если вы считаете, что код можно импортировать и использовать в других проектах, он должен находиться в каталоге / pkg . Если код нельзя использовать повторно или вы не хотите, чтобы другие использовали его повторно, поместите этот код в каталог / внутренний . Вы будете удивлены тем, что сделают другие, поэтому четко выражайте свои намерения!

Обычно есть небольшая функция main , которая импортирует и вызывает код из каталогов / internal и / pkg и ничего больше.

Примеры см. В каталоге / cmd .

Частное приложение и код библиотеки. Это код, который вы не хотите, чтобы другие импортировали в свои приложения или библиотеки. Обратите внимание, что этот шаблон макета применяется самим компилятором Go. Дополнительные сведения см. В примечаниях к выпуску Go 1.4 . Обратите внимание, что вы не ограничены внутренним каталогом верхнего уровня . Вы можете иметь более одного внутреннего каталога на любом уровне дерева проекта.

При желании вы можете добавить немного дополнительной структуры к своим внутренним пакетам, чтобы разделить общий и не общий внутренний код. Это не обязательно (особенно для небольших проектов), но хорошо иметь визуальные подсказки, показывающие предполагаемое использование пакета. Фактический код вашего приложения может находиться в каталоге / internal / app (например, / internal / app / myapp ), а код, совместно используемый этими приложениями, - в каталоге / internal / pkg (например, / internal / pkg / myprivlib ).