Опубликовано

[Перевод] Пишем техническую документацию: руководство для непрофессионала

Осенью 2016 года нам с коллегой поручили улучшить документацию и контент в моей бывшей компании. Мы потратили год на все виды документации: справочник по API, руководства, учебные пособия, сообщения в блогах. До этого я 5 лет писала доки, но официально не обучалась этому. Но и неопытной меня нельзя назвать: кроме документирования API для проектов и стартапа, я ещё преподавала Python Flask на семинарах во время учёбы на последних курсах в университете. Но сейчас выпала возможность сосредоточиться только на любимом деле: помогать специалистам всех уровней через техническую документацию.

В этом году я многому научилась в сообществе Write The Docs, у других провайдеров API, а также методом проб и ошибок. В прошлом году я поделилась опытом в докладе «Что мне хотелось бы знать о написании документации» на конференции API Strategy and Practice в Портленде. Эта статья — обзор полученных знаний.
Читать дальше →
[Перевод] Пишем техническую документацию: руководство для непрофессионала
Source: habrahabr

Опубликовано

Пост №3622017

Автор: Страж

Развернуть { «@context»: «http://schema.org», «@type»: «BlogPosting», «mainEntityOfPage»:{ «@type»:»WebPage», «@id»:»http://wh.reactor.cc/post/3622017″ }, «headline»: «у 'Я — i* ¿ ^ J * % 1 ' ч ^ ^ • / plague marine :: Nurgle :: Wh Cosplay :: Wh Other :: Death Guard :: Chaos (Wh 40000) :: Warhammer 40000 (warhammer40000, warhammer40k, warhammer 40k, ваха, сорокотысячник) :: фэндомы», «image»: { «@type»: «ImageObject», «url»: «http://img0.joyreactor.cc/pics/post/full/plague-marine-Nurgle-Chaos-%28Wh-40000%29-Warhammer-40000-4669170.jpeg», «height»: 960, «width»: 960 }, «datePublished»: «2018-08-28T16:50:57+03:00», «dateModified»: «2018-08-28T16:50:57+03:00», «author»: { «@type»: «Person», «name»: «Страж» }, «publisher»: { «@type»: «Organization», «name»: «JoyReactor.cc», «logo»: { «@type»: «ImageObject», «url»: «http://joyreactor.cc/images/joyreactor_ie6.png», «width»: 207, «height»: 54 } }, «description»: «» }
Комментировать 
Пост №3622017
Source: Joyreactor

Опубликовано

Комьюнити-директор Spider-Man повздорил с геймерами из-за даунгрейда

В сети разгорелся жаркий спор из-за даунгрейда, в котором заподозрили грядущую Marvel’s Spider-Man. Insomniac Games предсказуемо встала на защиту своего детища, однако переубедить разъярённых геймеров […]
Комьюнити-директор Spider-Man повздорил с геймерами из-за даунгрейда
Source: 4pda

Опубликовано

Пост №3622002

Автор: подозриткльный

Она уверенно наклоняет своё лицо, пока ваши пальцы касаются её шеи 1: [Поцеловать её] 2: [Наклониться поближе и издать пердящий звук прямо ей в ухо]Развернуть { «@context»: «http://schema.org», «@type»: «BlogPosting», «mainEntityOfPage»:{ «@type»:»WebPage», «@id»:»/post/3622002″ }, «headline»: «Она уверенно наклоняет своё лицо, пока ваши пальцы касаются её шеи / Pillars of Eternity 2 :: Pillars of Eternity :: RPG :: романтика :: Игры», «image»: { «@type»: «ImageObject», «url»: «http://img1.joyreactor.cc/pics/post/full/RPG-%D0%98%D0%B3%D1%80%D1%8B-%D1%80%D0%BE%D0%BC%D0%B0%D0%BD%D1%82%D0%B8%D0%BA%D0%B0-Pillars-of-Eternity-2-4669153.jpeg», «height»: 452, «width»: 1009 }, «datePublished»: «2018-08-28T16:40:32+03:00», «dateModified»: «2018-08-28T16:40:32+03:00», «author»: { «@type»: «Person», «name»: «подозриткльный» }, «publisher»: { «@type»: «Organization», «name»: «JoyReactor.cc», «logo»: { «@type»: «ImageObject», «url»: «http://joyreactor.cc/images/joyreactor_ie6.png», «width»: 207, «height»: 54 } }, «description»: «1: [Поцеловать её] 2: [Наклониться поближе и издать пердящий звук прямо ей в ухо]» }
Комментировать 
Пост №3622002
Source: Joyreactor

Опубликовано

Пост №3621987

Автор: Анонимус Первый

ОригиналРазвернуть { «@context»: «http://schema.org», «@type»: «BlogPosting», «mainEntityOfPage»:{ «@type»:»WebPage», «@id»:»http://anime.reactor.cc/post/3621987″ }, «headline»: «Оригинал / Kaban (Kaban (Kemono Friends)) :: Serval (Kemono Friends) :: Fennec (Kemono Friends) :: Common Raccoon (Kemono Friends) :: Kemono Friends Комиксы :: Anime Комиксы :: Kemono Friends :: перевел сам :: 1629doyasa :: Anime (Аниме)», «image»: { «@type»: «ImageObject», «url»: «http://img1.joyreactor.cc/pics/post/full/1629doyasa-Kaban-Kemono-Friends-Anime-4669241.png», «height»: 2894, «width»: 2039 }, «datePublished»: «2018-08-28T16:27:08+03:00», «dateModified»: «2018-08-28T16:27:08+03:00», «author»: { «@type»: «Person», «name»: «Анонимус Первый» }, «publisher»: { «@type»: «Organization», «name»: «JoyReactor.cc», «logo»: { «@type»: «ImageObject», «url»: «http://joyreactor.cc/images/joyreactor_ie6.png», «width»: 207, «height»: 54 } }, «description»: «» }
Комментировать 
Пост №3621987
Source: Joyreactor

Опубликовано

Пост №3621981

Автор: MPAK41

Развернуть { «@context»: «http://schema.org», «@type»: «BlogPosting», «mainEntityOfPage»:{ «@type»:»WebPage», «@id»:»/post/3621981″ }, «headline»: «darilic_comics :: смешные комиксы :: Смешные комиксы (веб-комиксы с юмором и их переводы) :: котэ (прикольные картинки с кошками)», «image»: { «@type»: «ImageObject», «url»: «http://img0.joyreactor.cc/pics/post/full/darilic_comics-%D1%81%D0%BC%D0%B5%D1%88%D0%BD%D1%8B%D0%B5-%D0%BA%D0%BE%D0%BC%D0%B8%D0%BA%D1%81%D1%8B-%D0%9A%D0%BE%D0%BC%D0%B8%D0%BA%D1%81%D1%8B-%D0%BA%D0%BE%D1%82%D1%8D-4669114.jpeg», «height»: 2160, «width»: 1626 }, «datePublished»: «2018-08-28T16:23:39+03:00», «dateModified»: «2018-08-28T16:23:39+03:00», «author»: { «@type»: «Person», «name»: «MPAK41» }, «publisher»: { «@type»: «Organization», «name»: «JoyReactor.cc», «logo»: { «@type»: «ImageObject», «url»: «http://joyreactor.cc/images/joyreactor_ie6.png», «width»: 207, «height»: 54 } }, «description»: «» }
Комментировать 
Пост №3621981
Source: Joyreactor

Опубликовано

Пост №3621977

Автор: 8l8i8

Развернуть { «@context»: «http://schema.org», «@type»: «BlogPosting», «mainEntityOfPage»:{ «@type»:»WebPage», «@id»:»/post/3621977″ }, «headline»: «ТЫ ЗНАШЬ… Я ^ 'помог зтой вселенной, но С КАКНЯММ ПРОСТРАНСТВА 1А РеАЛЬНОСЩ я мог/ посетить др / dorkly :: Marvel (Вселенная Марвел) :: DC Comics (DC Universe, Вселенная ДиСи) :: Смешные комиксы (веб-комиксы с юмором и их переводы) :: фэндомы», «image»: { «@type»: «ImageObject», «url»: «http://img0.joyreactor.cc/pics/post/full/%D0%9A%D0%BE%D0%BC%D0%B8%D0%BA%D1%81%D1%8B-Marvel-%D1%84%D1%8D%D0%BD%D0%B4%D0%BE%D0%BC%D1%8B-DC-Comics-4669102.png», «height»: 3333, «width»: 1000 }, «datePublished»: «2018-08-28T16:20:56+03:00», «dateModified»: «2018-08-28T16:20:56+03:00», «author»: { «@type»: «Person», «name»: «8l8i8» }, «publisher»: { «@type»: «Organization», «name»: «JoyReactor.cc», «logo»: { «@type»: «ImageObject», «url»: «http://joyreactor.cc/images/joyreactor_ie6.png», «width»: 207, «height»: 54 } }, «description»: «угие вселенные и А ^ помочь им тлкже. ^ Я ДОСТАТОЧНО ОТДОХНУЛ…» }
Комментировать 
Пост №3621977
Source: Joyreactor

Опубликовано

Пост №3621966

Автор: AshyAngel

фотографии-оригиналы затерялись, нету на компеРазвернуть { «@context»: «http://schema.org», «@type»: «BlogPosting», «mainEntityOfPage»:{ «@type»:»WebPage», «@id»:»/post/3621966″ }, «headline»: «Эмили Колдуин :: Dishonored :: Каляки-Маляки (каляки-маляки, Каляки-Маляки, #Каляки-Маляки, #каляки-маляки,) :: шахтер :: перерисовки фотографий :: кузмич :: индус :: особенности национальной охоты :: мужик :: балалайка :: ПВН :: отсканировано :: разное :: Игры», «image»: { «@type»: «ImageObject», «url»: «http://img0.joyreactor.cc/pics/post/full/%D0%9A%D0%B0%D0%BB%D1%8F%D0%BA%D0%B8-%D0%9C%D0%B0%D0%BB%D1%8F%D0%BA%D0%B8-%D1%80%D0%B0%D0%B7%D0%BD%D0%BE%D0%B5-%D0%BF%D0%B5%D1%80%D0%B5%D1%80%D0%B8%D1%81%D0%BE%D0%B2%D0%BA%D0%B8-%D1%84%D0%BE%D1%82%D0%BE%D0%B3%D1%80%D0%B0%D1%84%D0%B8%D0%B9-%D0%B8%D0%BD%D0%B4%D1%83%D1%81-4669086.jpeg», «height»: 7020, «width»: 5100 }, «datePublished»: «2018-08-28T16:08:10+03:00», «dateModified»: «2018-08-28T16:08:10+03:00», «author»: { «@type»: «Person», «name»: «AshyAngel» }, «publisher»: { «@type»: «Organization», «name»: «JoyReactor.cc», «logo»: { «@type»: «ImageObject», «url»: «http://joyreactor.cc/images/joyreactor_ie6.png», «width»: 207, «height»: 54 } }, «description»: «фотографии-оригиналы затерялись, нету на компе» }
Комментировать 
Пост №3621966
Source: Joyreactor

Опубликовано

[recovery mode] Обзор PocketBook 616 – самого бюджетного покетбука 2018 года с функцией подсветки

Всем привет!

В самом конце лета 2018 года компания PocketBook выпустила обновленную линейку ридеров. В неё входят три модели, а именно PocketBook 616 (8 900 рублей), PocketBook 627 (10 900 рублей) и PocketBook 632 (12 900 рублей). Обзоры всех этих устройств появятся в официальном блоге PocketBook на «Хабре», и первый из них вы как раз сейчас читаете. Начать я решил с PocketBook 616, самого доступного по цене представителя новой линейки.


Читать дальше →
[recovery mode] Обзор PocketBook 616 – самого бюджетного покетбука 2018 года с функцией подсветки
Source: geektimes

Опубликовано

Пост №3621960

Автор: Proteus_An

Развернуть { «@context»: «http://schema.org», «@type»: «BlogPosting», «mainEntityOfPage»:{ «@type»:»WebPage», «@id»:»/post/3621960″ }, «headline»: «BloodBorne :: Sekibanki :: Dark Souls :: Touhou Project (Touhou, Тохо) :: crossover :: misohagi :: Anime (Аниме) :: фэндомы», «image»: { «@type»: «ImageObject», «url»: «http://img1.joyreactor.cc/pics/post/full/Sekibanki-Touhou-Project-Anime-BloodBorne-4669073.jpeg», «height»: 2048, «width»: 1448 }, «datePublished»: «2018-08-28T15:57:41+03:00», «dateModified»: «2018-08-28T15:57:41+03:00», «author»: { «@type»: «Person», «name»: «Proteus_An» }, «publisher»: { «@type»: «Organization», «name»: «JoyReactor.cc», «logo»: { «@type»: «ImageObject», «url»: «http://joyreactor.cc/images/joyreactor_ie6.png», «width»: 207, «height»: 54 } }, «description»: «» }
Комментировать 
Пост №3621960
Source: Joyreactor