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

[krakenkaken]

Потрясающе, взяла все в работу

[Aggle]

Отлично! И да, я видел некоторое дерьмо такую документацию.

[MProvo]

Впишу в Styleguide

[iliamsk]

Дополню в комменты к https://habr.com/ru/articles/830584/

Чтобы сохранить проект, в правой верхней части окна нажмите Сохранить

А почему его зовут «Хрен попадешь»? — Потому что в него хрен попадешь :)

[APetrMP]

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

[APetrMP]

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

Wк=Пиhк((0.5DВк)^2-(0.5Dвк)^2)

Юзер обязан знать сам, что "объем кольца равен Пи умноженному на толщину кольца умноженному на разницу квадратов внешнего и внутреннего радиусов этого кольца".

[APetrMP]

Решил попрактиковаться:

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

[makushevkm]

Отлично получается, растёте на глазах как специалист :)