СФ
ладно, раз уж мы на сильных мира сего замахнулись, то некоторые части документации Pandoc (например, про фильтры, https://pandoc.org/lua-filters.html), тоже не очень:) тяжеловато написано и так себе структурировано
Size: a a a
2020 August 14
B
я наконец дочитала все новые сообщения и не вижу ответа на этот интригующий вопрос 😭
Ну, анал же)
NJ
Burrito
Ну, анал же)
я думала поизобретательнее будет, "АналСерв"или вроде того 😆
B
я думала поизобретательнее будет, "АналСерв"или вроде того 😆
Это было в тему функционал как человек нетрадиционной ориентации
B
Поэтому анал, функционал, все одно)
АП
Пятничный «отвести душу» челлендж:
Накидайте, пожалуйста, примеры плохой документации (желательно, публичной), с которой вы столкнулись в последнее время.
Накидайте, пожалуйста, примеры плохой документации (желательно, публичной), с которой вы столкнулись в последнее время.
Мало кто поймет, но это документация из базы знаний по ККТ одного из производителей.
https://onedrive.live.com/redir?resid=189C614ED00D4C23%21128&authkey=%21ABE4IM6eOvPtlrQ&page=View&wd=target%28%D0%90%D0%A2%D0%9E%D0%9B%2090%D0%A4.one%7C69af6d2a-550d-4965-b6d5-91cba681a925%2F%D0%9F%D0%B5%D1%80%D0%B5%D0%BD%D0%BE%D1%81%20%D0%B1%D0%B0%D0%B7%D1%8B%20%D1%82%D0%BE%D0%B2%D0%B0%D1%80%D0%BE%D0%B2%7Ca2246d10-caa8-4905-8f83-489d1d48d357%2F%29
https://onedrive.live.com/redir?resid=189C614ED00D4C23%21128&authkey=%21ABE4IM6eOvPtlrQ&page=View&wd=target%28%D0%90%D0%A2%D0%9E%D0%9B%2090%D0%A4.one%7C69af6d2a-550d-4965-b6d5-91cba681a925%2F%D0%9F%D0%B5%D1%80%D0%B5%D0%BD%D0%BE%D1%81%20%D0%B1%D0%B0%D0%B7%D1%8B%20%D1%82%D0%BE%D0%B2%D0%B0%D1%80%D0%BE%D0%B2%7Ca2246d10-caa8-4905-8f83-489d1d48d357%2F%29
NJ
Burrito
Поэтому анал, функционал, все одно)
😆
СФ
Мало кто поймет, но это документация из базы знаний по ККТ одного из производителей.
https://onedrive.live.com/redir?resid=189C614ED00D4C23%21128&authkey=%21ABE4IM6eOvPtlrQ&page=View&wd=target%28%D0%90%D0%A2%D0%9E%D0%9B%2090%D0%A4.one%7C69af6d2a-550d-4965-b6d5-91cba681a925%2F%D0%9F%D0%B5%D1%80%D0%B5%D0%BD%D0%BE%D1%81%20%D0%B1%D0%B0%D0%B7%D1%8B%20%D1%82%D0%BE%D0%B2%D0%B0%D1%80%D0%BE%D0%B2%7Ca2246d10-caa8-4905-8f83-489d1d48d357%2F%29
https://onedrive.live.com/redir?resid=189C614ED00D4C23%21128&authkey=%21ABE4IM6eOvPtlrQ&page=View&wd=target%28%D0%90%D0%A2%D0%9E%D0%9B%2090%D0%A4.one%7C69af6d2a-550d-4965-b6d5-91cba681a925%2F%D0%9F%D0%B5%D1%80%D0%B5%D0%BD%D0%BE%D1%81%20%D0%B1%D0%B0%D0%B7%D1%8B%20%D1%82%D0%BE%D0%B2%D0%B0%D1%80%D0%BE%D0%B2%7Ca2246d10-caa8-4905-8f83-489d1d48d357%2F%29
представил, какие эмоции испытывают читатели таких инструкций, и немного глаз задергался
V
тем не менее, самая плохая документация на мой взгляд это та, которой нет. и это до сих встречается чаще, чем хотелось бы
OR
Когда документации нет - это, конечно, беда. Но мне кажется, что еще хуже - это когда она есть, но информация внутри нее противоречит себе, а также что-то из нее - верно и актуально, а что-то - неактуально, что-то - неверно. Это, считай, ее нет, но она как бы есть, читай и разбирайся.
OR
особенно когда задача не как специалиста "посмотри, разберись и обнови", а как у простого пользователя - научиться
FM
Примеры не вспомню уже. Но документация на maven ужасна. Ужасна документация на всякие рокетсайн, где, чтобы что понять, надо быть разработчиком java.
Крики и боли...
Крики и боли...
FM
Как настроить gradle и docbook под винду, и не свихнуться...
А еще npm сломался и pip глючит..
А еще npm сломался и pip глючит..
KC
ладно, раз уж мы на сильных мира сего замахнулись, то некоторые части документации Pandoc (например, про фильтры, https://pandoc.org/lua-filters.html), тоже не очень:) тяжеловато написано и так себе структурировано
+1
NJ
а может у кого-то есть рыба для руководства пользователя (не ГОСТ)?
NJ
или был опыт составления такой рыбы?
JM
А ещё https://www.robotstxt.org/ ну такое себе.
А тут что плохого?
JM
Мало кто поймет, но это документация из базы знаний по ККТ одного из производителей.
https://onedrive.live.com/redir?resid=189C614ED00D4C23%21128&authkey=%21ABE4IM6eOvPtlrQ&page=View&wd=target%28%D0%90%D0%A2%D0%9E%D0%9B%2090%D0%A4.one%7C69af6d2a-550d-4965-b6d5-91cba681a925%2F%D0%9F%D0%B5%D1%80%D0%B5%D0%BD%D0%BE%D1%81%20%D0%B1%D0%B0%D0%B7%D1%8B%20%D1%82%D0%BE%D0%B2%D0%B0%D1%80%D0%BE%D0%B2%7Ca2246d10-caa8-4905-8f83-489d1d48d357%2F%29
https://onedrive.live.com/redir?resid=189C614ED00D4C23%21128&authkey=%21ABE4IM6eOvPtlrQ&page=View&wd=target%28%D0%90%D0%A2%D0%9E%D0%9B%2090%D0%A4.one%7C69af6d2a-550d-4965-b6d5-91cba681a925%2F%D0%9F%D0%B5%D1%80%D0%B5%D0%BD%D0%BE%D1%81%20%D0%B1%D0%B0%D0%B7%D1%8B%20%D1%82%D0%BE%D0%B2%D0%B0%D1%80%D0%BE%D0%B2%7Ca2246d10-caa8-4905-8f83-489d1d48d357%2F%29
"булка, водка, салфетка..." 😂
JM
А!! Вы тут примеры плохой документации собираете!!
Я не знаю, плохая это или нет, но не могу не запостить. На этой неделе заскриншотил. 🤭
Я не знаю, плохая это или нет, но не могу не запостить. На этой неделе заскриншотил. 🤭
FM
Пить надо меньше!