Size: a a a

Технические писатели

2021 August 31

А

Александр Мокрушин... in Технические писатели
+1 к развитию поиска. Можно подумать над поиском по конкретной книге/части веб-справки
источник

VB

Vitaly Belyakov in Технические писатели
теги кстати да, мощная штука. Главное, приучить техписов проставлять их всегда и по теме)
источник

AB

Albina Brycheva in Технические писатели
По нашему опыту обратная связь оказалась полезной функцией на сайте. Добавляли без особых ожиданий
источник

OR

Olga Revyakina in Технические писатели
в идеале - возможность сослаться на любой подраздел, т.е. автоматический тег для каждого подраздела на странице
источник

D

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

А

Александр Мокрушин... in Технические писатели
да, комменты - вещь неодназначная, надо смотреть на специфику аудитории.
Я имел в виду не отзывы, а возможность кликнуть на кнопку "Статья полезна"
источник

VB

Vitaly Belyakov in Технические писатели
наверное, я очень плохой человек, но почти никогда не кликаю на такую кнопку) не по злому умыслу, а я просто её не вижу. Я быстро выцепил нужную мне инфу и свалил дальше решать задачу.

Тут, мне кажется, большое подходят такие инструменты веб-аналитики, как отслеживание длительности нахождения на веб-странице и количество просмотров.
источник

А

Александр Мокрушин... in Технические писатели
+ Кнопка для копирования примеров кода
источник

ДЧ

Дарья Чернавина... in Технические писатели
Где??? Я готова отдать любые деньги тому магазину, что его продаёт.
источник

AB

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

BF

Bobba Fett in Технические писатели
Конечно, конкуренты только и думают как бы накликать минусов в документации) этот компонент не для точного анализа нужен, а на «подумать» например, бывает что кажущаяся плохая статья неожиданно положительно оценена или наоборот. А фидбек полезен для отлова опечаток, неточностей, устаревших данных в документации
источник

AB

Albina Brycheva in Технические писатели
я тоже так сказала 😀. Слишком сложный сценарий, имхо
источник

BF

Bobba Fett in Технические писатели
Современный хантинг
источник

вд

всем добра in Технические писатели
Черепикай мою ветку полностью 😄
источник

CD

Constantine Drozdov in Технические писатели
Нужны ещё шутки про пуш, фетч и ребейз
источник

вд

всем добра in Технические писатели
Собачка которая призывает к релизу в прод
источник

AS

Anastasiya Selivanav... in Технические писатели
Я вот добавила в список хотелок иконки или лейблы для новых статей или для статей, которые актуальны только для бета-версии софта.
А можете показать пример, как у вас оформления блоки с примерами?
Названия полей и кнопок у нас просто полужирным, как и у многих.
источник

AS

Anastasiya Selivanav... in Технические писатели
Согласна на 1000%. Поиск у нас уже есть!
источник

OR

Olga Revyakina in Технические писатели
На самом деле, обычный кат, только другого цвета ) У нас примеры кода могут быть длинные, поэтому прячем под кат. Но выделяем цветом.
источник

AS

Anastasiya Selivanav... in Технические писатели
Ага, очень важная штука. У нас такая стоит уже. Люди пишут и об опечатках, и об ошибках, и о недостающей информации. Задают вопросы. В общем, нужная вещь.
источник