#проверка_документации — Public Fediverse posts

Проверяем текст: кейс автоматизации с линтером Vale

Привет, на связи Марина и Катя ( @lieutkat ) — технические писатели Читать дальше

https://habr.com/ru/companies/cloud_ru/articles/865604/

#автоматизация #редакционная_политика #проверка_документации #линтеры #линтер_vale

5 причин, почему пользователи терпеть ненавидят вашу документацию [и как это исправить]

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда. Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.

https://habr.com/ru/articles/811461/

#документация #документация_кода #документация_проекта #технические_писатели #документирование #пользовательская_документация #технология_единого_источника #проверка_документации #техническая_документация #обратная_связь

5 причин, почему пользователи терпеть ненавидят вашу документацию [и как это исправить]

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда. Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.

https://habr.com/ru/articles/811461/

#документация #документация_кода #документация_проекта #технические_писатели #документирование #пользовательская_документация #технология_единого_источника #проверка_документации #техническая_документация #обратная_связь

5 причин, почему пользователи терпеть ненавидят вашу документацию [и как это исправить]

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет всё это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»... Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Маловероятно, что кто-то из технических писателей хочет специально выдать плохой документ. Скорее наоборот — авторы изо всех сил стараются, чтобы документация была полезной, понятной и удобной. Но, несмотря на все усилия, идеальный результат получается далеко не всегда. Давайте разберём пять основных претензий читателей к технической документации, и подумаем, что со всем этим делать.

https://habr.com/ru/articles/811461/

#документация #документация_кода #документация_проекта #технические_писатели #документирование #пользовательская_документация #технология_единого_источника #проверка_документации #техническая_документация #обратная_связь

Проверка поставщика в Китае своими силами

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

https://habr.com/ru/articles/819421/

#китай #проверка_фабрики #проверка_контрагента #проверка_поставщика #проверка_производителя #проверка_документации #проверка_подлинности #проверка_производства #аудит_предприятия #аудит_завода

17 вредных советов для тех, кто проверяет документацию и технические тексты

Вы пишете документацию, статьи или другие тексты? Тогда, наверняка, у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену... Я начал коллекционировать самые фееричные комментарии. Делал я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к текстам. Эти советы — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов. Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.

https://habr.com/ru/articles/811321/

#документация #техническая_документация #разработка_документации #проверка_документации #комментарии #правки #технические_писатели #авторы

17 вредных советов для тех, кто проверяет документацию и технические тексты

Вы пишете документацию, статьи или другие тексты? Тогда, наверняка, у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену... Я начал коллекционировать самые фееричные комментарии. Делал я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к текстам. Эти советы — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов. Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.

https://habr.com/ru/articles/811321/

#документация #техническая_документация #разработка_документации #проверка_документации #комментарии #правки #технические_писатели #авторы

17 вредных советов для тех, кто проверяет документацию и технические тексты

Вы пишете документацию, статьи или другие тексты? Тогда, наверняка, у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену... Я начал коллекционировать самые фееричные комментарии. Делал я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к текстам. Эти советы — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов. Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.

https://habr.com/ru/articles/811321/

#документация #техническая_документация #разработка_документации #проверка_документации #комментарии #правки #технические_писатели #авторы

17 вредных советов для тех, кто проверяет документацию и технические тексты

Вы пишете документацию, статьи или другие тексты? Тогда, наверняка, у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену... Я начал коллекционировать самые фееричные комментарии. Делал я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к текстам. Эти советы — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов. Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.

https://habr.com/ru/articles/811321/

#документация #техническая_документация #разработка_документации #проверка_документации #комментарии #правки #технические_писатели #авторы