getdocument – Telegram
getdocument
160 subscribers
32 links
Канал рассказывает о разных моментах в работе технических писателей и аналитиков. Автор канала - Антон Самарин.
Download Telegram
Channel created
Отзыв на курс по системной аналитике
Channel name was changed to «getdocument»
"Впервые в рамках концеренции "Город ИТ"( https://gorod.it/), 7 сентября, будет проведена секция по Системному анализу в ИТ. У кого есть знакомые аналитики в Сибири или есть интерес к работе аналитиков - приходите."
О пользе Python в работе технического писателя: http://getdocument.ru/2019/07/24/why-python-is-good-for-technical-writer/
Что делать техписателю в первые дни на новой работе: http://getdocument.ru/2019/07/25/what-to-do-at-new-place/
Труды техписателя: Quickstart: http://getdocument.ru/2019/07/31/techwriter-output-quickstart/
Как быстро установить zsh: http://getdocument.ru/2019/08/01/how-to-install-zsh/
31-го августа в Новосибирске пройдёт 12-й Конвеерум. Подробности: http://getdocument.ru/2019/08/06/konveerum-no-12/
На этой неделе я познакомился с редактором Markdown-кода http://hackmd.io. Удобный редактор: можно писать документы в любимом формате Markdown, сохранять их и экспортировать результат в несколько форматов, включая HMTL. В формат PDF вроде тоже можно, но я не нашёл такой опции.
Cписок возможностей доступен на странице: https://hackmd.io/features
Девятнадцатого октября в Ижевске пройдёт Удмуртская Интернет-конференция UIC DEV.

Одним из спикеров на конференции будет Евгений Галактионов, наш коллега и ведущий инструктор по системному анализу.

Коротко о выступлении Евгения:

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

Может получиться, что невозможно без дополнительной доработки всей системы получить нужную отчетность. А любая доработка – это дополнительные затраты времени и денег, а следовательно, возможные конфликты между заказчиком и исполнителем.

Основные ситуации, когда невозможно получить нужные отчеты:
1. Данные для получения отчетов отсутствуют в системе, так как не были спроектированы процессы по внесению исходных данных.
2. Данные присутствуют, но непонятно, а эти ли данные нужны для формирования отчета и как это проверить?
3. Данные есть, но их так много, что попытка провести выборку и расчет для получения отчета требует многочасовых расчётов, а может и просто привести к зависанию системы.

Мы рассмотрим, почему такие ситуации происходят и как их избежать на этапе формирования функциональных требований к системе и разработки проекта модели предметной области.

👉 Купить билет на конференцию: http://short.picom.su/zvufUo
Как я учусь документировать API

Прежде всего, нужно понять основы. Для этого есть прекрасная книга «An Introduction to APIs», которая доступна по адресу https://zapier.com/learn/apis/. Она знакомит с нужными терминами и объясняет много полезных вещей. Её достоинство в том, что она небольшая и ты не успеешь устать.

После того, как теория стала понятна, можно переходить к курсу Тома Джонсона: https://idratherbewriting.com/learnapidoc/contact.html

Перевод курса Тома, выполненный Денисом Старковым, доступен по адресу https://starkovden.github.io/
Forwarded from DocOps
Опубликованы записи докладов и слайды недавней конференции API the Docs: https://pronovix.com/event/api-docs-amsterdam-2019.
Там всё про документирование кода и API.

Спасибо @aselivanava за ссылку :)