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

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

Лирическое отступление: у меня сегодня была какая-то странная проблема с подбором КДПВ, так что пусть ею будет вот такой комикс:

Читать дальше ->

https://habr.com/post/359270/?utm_source=habrahabr&utm_medium=rss&utm_campaign=359270