Как сделать техническую документацию

Обновлено: 07.07.2024

Единая система технологической документации

СТАДИИ РАЗРАБОТКИ И ВИДЫ ДОКУМЕНТОВ

Unified system of technological documentation. Stages of designing and types of documents. General principles

Дата введения 2012-01-01

Предисловие

Цели, основные принципы и общие правила проведения работ по межгосударственной стандартизации установлены ГОСТ 1.0 "Межгосударственная система стандартизации. Основные положения" и ГОСТ 1.2 "Межгосударственная система стандартизации. Стандарты межгосударственные, правила и рекомендации по межгосударственной стандартизации. Правила разработки, принятия, обновления и отмены"

Сведения о стандарте

1 РАЗРАБОТАН Федеральным государственным унитарным предприятием "Всероссийский научно-исследовательский институт стандартизации и сертификации в машиностроении" (ФГУП "ВНИИНМАШ"), Автономной некоммерческой организацией "Научно-исследовательский центр CALS-технологий "Прикладная логистика" ("АНО НИЦ CALS-технологий "Прикладная логистика")

2 ВНЕСЕН Федеральным агентством по техническому регулированию и метрологии

3 ПРИНЯТ Межгосударственным советом по стандартизации, метрологии и сертификации (протокол от 12 мая 2011 г. N 39)

За принятие стандарта проголосовали:

Краткое наименование страны по МК (ИСО 3166) 004-97

Сокращенное наименование национального органа по стандартизации

Минэкономики Республики Армения

Госстандарт Республики Беларусь

Госстандарт Республики Казахстан

4 Приказом Федерального агентства по техническому регулированию и метрологии от 3 августа 2011 г. N 212-ст межгосударственный стандарт ГОСТ 3.1102-2011 введен в действие в качестве национального стандарта Российской Федерации с 1 января 2012 г.

6 ИЗДАНИЕ (июль 2020 г.) с Поправками* (ИУС 12-2012, ИУС 9-2015)

* См. ярлык "Примечания".

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

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

1 Область применения

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

2 Нормативные ссылки

В настоящем стандарте использованы нормативные ссылки на следующие межгосударственные стандарты:

ГОСТ 2.103-68 Единая система конструкторской документации. Стадии разработки

ГОСТ 2.602-95 Единая система конструкторской документации. Ремонтные документы

3 Стадии разработки технологической документации

3.1 Стадии разработки технологической документации, применяемой для технологических процессов изготовления изделий (составных частей изделий), определяются в зависимости от стадий разработки используемой конструкторской документации по ГОСТ 2.103.

3.2 Стадии разработки рабочей технологической документации устанавливает разработчик документации в соответствии с таблицей 1.

Стадия разработки технологической
документации

Разработка технологической документации, предназначенной для изготовления и испытания материального макета изделия и (или) его составных частей с присвоением литеры "П", на основании конструкторской документации, выполненной на стадиях "Эскизный проект" и "Технический проект"

а) опытного образца (опытной партии)

Разработка технологической документации, предназначенной для изготовления и испытания опытного образца (опытной партии), без присвоения литеры, на основании конструкторской документации, не имеющей литеры.

Корректировка и разработка технологической документации по результатам изготовления и предварительных испытаний опытного образца (опытной партии) с присвоением литеры "О" на основании конструкторской документации, имеющей литеру "О".

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

б) серийного (массового) производства

Разработка технологической документации, предназначенной для изготовления и испытания изделий серийного (массового) производства, с присвоением литеры "А" ("Б") на основании конструкторской документации, имеющей литеру "А" или "Б"

3.3 На стадии разработки конструкторской документации "Техническое предложение" технологическую документацию не разрабатывают.

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

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

3.6 Технологической документации, предназначенной для разового изготовления одного или нескольких изделий (составных частей изделий) в единичном производстве, присваивают литеру "И" на основании конструкторской документации, имеющей литеру "И".

3.7 Ранее разработанные технологические документы (комплекты технологических документов) применяют при изготовлении новых или модернизации изготовляемых изделий в следующих случаях:

- на стадии разработки технологической документации "Предварительный проект" - независимо от литерности применяемой технологической документации;

- в технологической документации опытного образца (опытной партии) с литерой "" (""), серийного (массового) производства с литерами "А" и "Б", если литера применяемой технологической документации та же или высшая.

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

3.8 Стадии разработки рабочей технологической документации, применяемой для технологических процессов ремонта изделий (составных частей изделий), определяет разработчик документации в зависимости от применяемых видов документов на ремонт по ГОСТ 2.602 и стадии разработки ремонтной конструкторской документации - в соответствии с таблицей 2.

Стадия разработки технологической документации

а) опытного ремонта

Разработка технологической документации, предназначенной для опытного ремонта и испытания изделий (составных частей изделий), с присвоением технологической документации литеры "РО" на основании конструкторской документации, имеющей литеру "РО".

Разработка технологической документации, проверенной опытным ремонтом, с присвоением литеры " " ("")

б) серийного (массового) ремонтного производства

Разработка технологической документации, предназначенной для серийного (массового) ремонта и испытаний изделий (составных частей изделий), с присвоением технологической документации литеры "РА" ("РБ"), на основании конструкторской документации, имеющей литеру "РА" или "РБ"

3.9 Директивной технологической документации, предназначенной для выборочной и укрупненной разработки технологических процессов ремонта и испытания изделий (составных частей изделий), а также для решения необходимых инженерно-технических, планово-экономических и организационных задач, присваивают литеру "РД".

3.10 Технологической документации, предназначенной для разового ремонта одного или нескольких изделий (составных частей изделий) в единичном производстве, присваивают литеру "РИ" на основании конструкторской документации, имеющей литеру "РИ".

3.11 При разработке документации на технологические процессы, выполняемые на стадиях "Предварительный проект", "Опытный образец (опытная партия)" и "Опытный ремонт", ее следует выполнять в маршрутном и (или) маршрутно-операционном описании.

3.12 При разработке документации на технологические процессы, выполняемые на стадиях "Серийное (массовое) производство", "Серийное (массовое) ремонтное производство", ее следует выполнять в операционном описании.

Допускается разработка технологической документации:

- в маршрутно-операционном описании при условии ее применения в мелкосерийном производстве;

- на предыдущей стадии в сравнении со стадией разработки применяемой конструкторской документации при условии изготовления или ремонта ограниченной партии изделий (составных частей изделий).

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

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

Технологические документы, стандарты организаций, на которые приводят ссылки, подлежат передаче другой организации вместе с комплектом технологических документов, при этом форма выполнения передаваемых ссылочных документов [бумажная и (или) электронная] должна соответствовать форме выполнения документов, входящих в комплект, либо быть согласована с этой организацией.

4 Виды документов

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

4.2 К основным относят документы:

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

- полностью и однозначно определяющие технологический процесс (операцию) изготовления или ремонта изделия (составных частей изделия).

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

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

Справка " Целесообразность разработки документации на ГИС "

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

Тектс программы (ГОСТ 19.401-78 "Текст программы. Требования к содержанию и оформлению");
Спецификация (ГОСТ 202-78 "Спецификация. Требования к содержанию и оформлению");
Руководство оператора (ГОСТ 19.505-79 "Руководство оператора. Требования к содержанию и оформлению").

ГИС: техническая и рабочая документация в соответствии с ПП №676, ГОСТ 34
ПО: рабочий проект в соответствии с ГОСТ 19

"Целесообразность разработки докумнтации на ГИС / ПО"

Общие требования к
документации на ГИС

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

По итогам оказания услуг формируется комплект документации , подлежащий согласованию и утверждению Заказчиком, на бумажном носителе в сброшюрованном виде в 2-х экземплярах и в электронном виде на внешнем носителе, в формате Microsoft Word. Оформление документов должно быть основано на требованиях ГОСТ 2.105-2019 "Единая система конструкторской документации. Общие требования к текстовым документам".

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

Схема организационной структуры;
Описание организационной структуры;
Схема структурная комплекса технических средств;
Схема функциональной структуры;
Схема автоматизации;
Ведомость технического проекта;
Пояснительная записка к техническому проекту;
Описание автоматизируемых функций;
Описание постановки задач (комплекса задач);
Описание информационного обеспечения системы;
Описание организации информационной базы;
Описание массива информации;
Описание комплекса технических средств;
Описание программного обеспечения;
Описание алгоритмов;
Описание применяемых языков программирования;
Описание программы.

Разработка / актуализация рабочей документации включает разработку документации, содержащей сведения, необходимые для выполнения работ по вводу ГИС в эксплуатацию и ее эксплуатации, и порядка эксплуатации ГИС, содержащего сведения, необходимые для выполнения работ по поддержанию уровня эксплуатационных характеристик (качества), в том числе:

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

В рамках оказания услуг Исполнителем обеспечивается разработка документации на ПО, удовлетворяющей требованиям:

ГОСТ 19.101-77 "Виды программ и программных документов";
ГОСТ 19.401-78 "Текст программы. Требования к содержанию и оформлению";
ГОСТ 202-78 "Спецификация. Требования к содержанию и оформлению";
ГОСТ 19.505-79 "Руководство оператора. Требования к содержанию и оформлению".

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

У многих управляющих организаций возникает вопрос: что входит в состав технической документации МКД, обязательной для хранения? Некоторые УО жалуются, что в этом вопросе нет полной ясности, потому что в законодательстве представлен размытый перечень. В действительности же это не так. В законе вполне ясно говорится о составе, порядке хранения и обновлении ТД.

Перечень документов

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

Перечисленные документы передаются от застройщика, предыдущей УО или собственников (в том случае, если дом находился в непосредственном управлении). Таких документов, как инструкции по эксплуатации МКД и проектная документация, у УО может и не быть, если они были по каким-то причинам утрачены. В первую очередь это относится к старым домам, построенным в прошлом веке или раньше.

Другие документы, которые есть далеко не всегда, – договоры об использовании общего имущества МКД и документы о действии сервитута или иного обременения. Очевидно, что они есть только в тех МКД, собственники которых сдают в аренду ОИ или согласились на установление сервитута.

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

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

Часть названных документов хранится в неизменном виде, а часть обновляется: это информация о собственниках и нанимателях помещений в МКД, а также о лицах, использующих ОИ в МКД на основании договоров, в том числе и ведение списков. Это устанавливается Стандартами управления МКД, которые введены постановлением Правительства РФ N 416. Соответственно, регулярно должны актуализироваться списки собственников, нанимателей и арендаторов, потому что меняется их состав.

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

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

Иные документы

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

Приём-передача техдокументации

Обратим ваше внимание на то, что нужно крайне ответственно подходить к вопросу о полноте технической документации и её своевременном обновлении. Потому что в случае передачи МКД другой УО, ТСЖ или собственникам в управление, вся техдокументация должна быть передана в полном объёме в 30-дневный срок. Если же какие-то документы отсутствуют либо утрачены, они должны быть восстановлены. (Порядок приёма-передачи технической документации установлен в постановлении Правительства РФ N 416.)

При приёме-передаче ТД новая УО проверяет не только наличие всех документов, но и их актуальность на момент передачи. Если здесь возникают какие-то проблемы, то новая УО указывает в протоколе приёма-передачи, что требует восстановления или обновления. После этого прежняя УО обязана в течение 3 месяцев восстановить или обновить документы, а затем передать их по отдельному акту приёма-передачи вновь выбранной УО.

И на какие бы причины отсутствия техдокументации старая УО ни ссылалась, она обязана её передать, что явно следует из постановления Президиума Высшего Арбитражного Суда РФ. Согласно ему, отсутствие или утрата ТД не прекращает обязанность по её передаче.

Если и после 3 месяцев документы не переданы новой УО, можно смело обращаться в суд, в ГЖИ, в прокуратуру. И это вполне адекватная мера, поскольку иначе невозможно будет осуществлять полноценное управление домом. Это также позволит подстраховаться на случай передачи МКД другой УО – избежать затрат на восстановление технической документации (ведь затраты при этом ложатся именно на УО) и возможных штрафов.

Если у вас остались вопросы, вы всегда можете обратиться к нам за консультацией. Также мы помогаем управляющим компаниям соответствовать 731 ПП РФ о Стандарте раскрытия информации (заполнение портала Реформа ЖКХ, сайта УК, информационных стендов) и ФЗ № 209 (заполнение ГИС ЖКХ). Мы всегда рады вам помочь!

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

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

Чем занимается БТИ

У Бюро есть несколько направлений деятельности. Основное — поддержание в актуальном виде каталога и всех данных по капитальным зданиям в городе.

БТИ устанавливает приблизительную стоимость и величину налога на типы объектов. Для этого сотрудники Бюро с периодичностью раз в пять лет или чаще проводят оценку состояния объектов и заносят актуальную информацию в базы. Эта информация требуется в том числе для установления физического износа и необходимости капитального ремонта.

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

БТИ делает выписки, технические планы, справки и паспорта по объектам недвижимости, которые требуются для оформления собственности, перепланировок или для сделок по купле и продаже жилья.

Важно отметить, что БТИ не обладает правом на установление юридических статусов объектов, оно только фиксирует данные и предоставляет информацию. Таким образом, здесь не производится регистрация права собственности. Этим занимается Росреестр.

Когда нужно обращаться в БТИ

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

Вы хотите осуществить перепланировку своей квартиры. Вам необходимо обратиться в БТИ, чтобы согласовать желаемый план помещения. Если он соответствует нормативам, то Бюро выдаст вам разрешение, затем проведет оценку перепланировки и зафиксирует новые данные в техническом паспорте объекта.
Вы хотите приобрести квартиру и вам необходимо убедиться в том, что объект юридически чист. В БТИ вы можете получить сведения о том, не находится ли жилье под арестом или в залоге и кто является собственником.
Вы хотите перевести нежилое помещение в жилое или наоборот. Это необходимо в случае, если вы хотите из квартиры сделать коммерческое жилье, из апартаментов — жилой объект. БТИ выдаст вам справку о соответствии недвижимости тем или иным требованиям.
Вы хотите узнать точную рыночную стоимость жилья. Обычно это требуется для продажи или покупки недвижимости, а также оформления залога. Эту услугу также можно заказать в БТИ. Сотрудники оценят качество строительных работ и материалов, учтут расположение и состояние дома.
Вы хотите уточнить расположение объекта. В Бюро вы можете получить справку, которая подтвердит точный адрес.
Вам требуется узнать план земельных участков на определенной территории. Это пригодится в случае земельных споров, когда в результате активной застройки дачи теряют свои точные границы.

Какие документы выдает БТИ

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

Экспликация — краткая информация в виде таблицы, которая отражает общую площадь квартиры, площадь ее помещений и высоту потолков.
Поэтажный план включает информацию об адресе, расположении, этажности здания, а также расположении квартир на этаже и их базовых характеристиках. из него включают уже более подробные сведения, в том числе материалы, из которых построено здание, информация о правах на объект. При заказе выписки можно уточнить, что требуются конкретные сведения. Чаще всего это данные о собственности и юридическом статусе помещения.
Технический план хоть по названию и похож на паспорт, но является отдельным документом, в котором указаны данные дома. В нем отражен год постройки, материалы строительства, степень износа, назначение объекта. Такой документ может пригодиться, если вы покупаете квартиру и хотите уточнить характеристики здания, в котором она находится.
Отчет по оценке объекта в зависимости от целей будет содержать подробные данные о квартире, метод, по которому проводилась оценка, и сам результат, в том числе ее стоимость (инвентаризационная, рыночная или кадастровая).
Заключение о возможной перепланировке дает согласие на изменение изначального плана в случае ремонта, например.
Межевой план фиксирует границы земельного участка на основе кадастрового плана.
Архивные справки подтверждают историю объекта, например, что на нем нет обременения.

Как получить документы в БТИ

Чтобы запросить и получить необходимые справки в БТИ, необходимо предоставить пакет документов:

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

Следует учитывать, что почти все справочные и консультационные услуги являются платными. Стоимость зависит от количества страниц в документе и квадратных метров объекта. Но на большую часть услуг стоимость фиксированная: 400–2500 руб.

Photo by James McKinven on Unsplash

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

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

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

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

Вопреки распространенному мнению, самая ценная документация пишется не для других людей. Как я написала в одном твите,

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

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

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

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

команды, которые вводите в терминале,
объяснения, почему предпочли один метод другому,
ссылки, которые посетили в поисках помощи или ~~кода для копипаста~~ вдохновения,
порядок выполнения действий.

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

2. Объясните свои решения более подробно

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

Чтобы все хорошо и подробно объяснить себе будущему, вам нужны свежие воспоминания о контексте, идеях и решениях.

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

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

Photo by Zan on Unsplash

3. Не забудьте упомянуть о предварительных знаниях

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

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

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

Спустя некоторое (даже довольно короткое!) время легко забыть какие-то детали, связанные с проектом, но не являющиеся его непосредственной частью. Записывайте все, что сочтете полезным.

Документируйте всё!

Проекты создания программ представляют собой намного больше, чем просто код. Чтобы в будущем сразу успешно начать работать с любым своим проектом, документируйте всё! Будь то установленная вами процедура, инфраструктура как код или мимолетная идея на будущее — записывайте! Когда-нибудь вы поблагодарите себя за это.

Читайте также: