Как писать техническую документацию? Ее содержимое — тексты? Как тексты техдокументации вообще, так и любые технические публикации, от журнальных статей до докторских диссертаций? Простые и эффективные способы, позволяющие писать тексты понятными, без применения каких–либо буржуйских технологий описания, удобочитаемыми и заведомо выдерживающими как самую жесткую и обоснованную критику, так и беспардонные, беспочвенные и технически не обоснованные заявления оппонентов. Редакция от 26.09.2024.

Кастомные (в пользовательском контексте) переменные в Drupal 8 могут применяться для хранения и представления исходных (вводных) данных проекта, в состав которых входят наименование проекта, наименование продукта проекта, даты инициации и завершения проекта, заказчик, руководитель, куратор, все заинтересованные стороны, все участники проекта и многое–многое другое, в том числе параметры ссылок на внешние системы управления проектами (трекерами вроде Jira или Redmine).

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

Пример документа «Каталог базы данных» (В7 по ГОСТ 34.201–89), разработанного для Интернет–портала согласно требованиям подраздела Каталог базы данных по РД 50–34.698–90 к структуре, содержанию и содержимому документа. Оформлен по ГОСТ 2.104 и ГОСТ 2.106. Редакция от 17.12.2024.

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

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

Редакция от 10.12.2024.

Практические приемы оценки и повышения качества техдокументации по оценочным элементам фактора «надежность» согласно ГОСТ 28195–89. Материал входит в цикл статей «Качество технической документации». Редакция от 11.12.2024.

Практические приемы оценки и повышения качества техдокументации по оценочным элементам фактора «сопровождаемость» согласно ГОСТ 28195–89. Материал входит в цикл статей «Качество технической документации». Редакция от 11.12.2024.

Практические приемы оценки и повышения качества техдокументации по оценочным элементам фактора «удобство применения» согласно ГОСТ 28195–89. Материал входит в цикл статей «Качество технической документации». Редакция от 11.12.2024.

Практические приемы оценки и повышения качества техдокументации по оценочным элементам фактора «эффективность» согласно ГОСТ 28195–89. Материал входит в цикл статей «Качество технической документации». Редакция от 11.12.2024.

Практические приемы оценки и повышения качества техдокументации по оценочным элементам фактора «универсальность» согласно ГОСТ 28195–89. Материал входит в цикл статей «Качество технической документации». Редакция от 11.12.2024.

Клонирование сущностей от проекта к проекту разумнее всего выполнять экспортом (безотносительно ГИС) предыдущего проекта с «последующим импортом последующего» 😂 Т.е. вновь создаваемого. Если, конечно, последующий проект представляется более–менее типовым.

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