Pull to refresh

Написание документации

Reading time3 min
Views29K
Если вы пишете документацию открытого исходного кода, то это не просто вежливые дополнение к проектам, она в определенной степени помогает вашему проекту взлететь. Хорошонаписаный README помогает, но полная документация по API делает проект более профессиональным. Даже если ваш проект с закрытым исходным кодом, документация поможет новым коллегам более быстро адаптироваться или поможет вам вспомнить как все работает в длительных проектах.

Давайте посмотрим как устроена документация в популярных JavaScript фрэймворках.

jQuery


jQuery

Документация jQuery располагается по адресу docs.jquery.com и представляет из себя wiki в которой описана вся документация по API. Любая крупная область API включена в навигацию, каждая страница имеет список методов для этой области. Страница содержит примеры кода и комментарии на Disqus.
Комментарии исходного кода в основном связаны с багами или с необычным фрагментом кода, который требует пояснений.

Далее: Prototype, JSDoc и несколько специфических подходов к JavaScript документации
Читать дальше →
Total votes 33: ↑31 and ↓2+29
Comments18

Если кто ещё не знает как правильно использовать продукты Google

Reading time1 min
Views21K
image

Поисковый гигант запустил новый проект Google Tips, функциональность которого точно соответствует своему названию. Помимо своей утилитарной цели — информировать в кратком виде о способах использования продуктов Google — дизайн сайта может служить хорошим примером презентации в веб: карточки и слайды действительно ведут себя интересно.
Узнать подробности
Total votes 29: ↑20 and ↓9+11
Comments3

Как структурировать проект на Golang: гайд от backend-разработчика

Reading time4 min
Views37K

Всем привет, меня зовут Авксентий, я backend-разработчик в inDriver. Думаю, каждый начинающий разработчик сталкивался с проблемой, как правильно выстроить архитектуру и структуру проекта. Ведь организация кода проекта — постоянно развивающаяся проблема, а следование стандартной структуре сохраняет чистоту кода и повышает производительность команды. 

Когда я начинал писать на Go, то потратил много времени на поиски стандартов структурирования проекта. В итоге так и не нашел официального и точного стандарта — либо информация была неполной, либо это было не то, что нужно. Я решил написать свой гайд на основе опыта. Он для начинающих разработчиков и посвящен тому, как структурировать проект на Golang.

Читать далее
Total votes 19: ↑17 and ↓2+15
Comments17

Docs as Code для художественной литературы. Делаем творческий сайт ребенка с помощью MkDocs

Level of difficultyEasy
Reading time13 min
Views7.4K


Docs as Сode — подход к работе с текстами, подразумевающий написание текста как кода:


  • в простом текстовом редакторе или IDE;
  • с использованием системы контроля версий;
  • с CI / CD / Code Review.

В настоящее время Docs as Code широко применяется при работе с технической документацией, давая техническим писателям и проектным командам массу удобств и преимуществ.


Но что если пойти дальше, попробовать такой подход не с техническими, а с художественными текстами? Что если автор — не технарь и не айтишник? Просто юный начинающий писатель, который пробует писать прозу и стихи ручкой на бумаге, и надеется познакомить широкую публику со своим творчеством?


В этой статье я расскажу о таком эксперименте (забегая вперед, удачном). Моей дочери 11 лет, она пишет сказки, стихи и рассказы. Чтобы поддержать ее увлечение, я помог ей создать литературный сайт, используя подход Docs as Code. Она успешно освоила основы Markdown и Git. Сейчас она самостоятельно публикует новые произведения и обновляет новости на своем сайте https://lib-beliakova.github.io/.

Читать дальше →
Total votes 44: ↑44 and ↓0+44
Comments17

Разработчики передают привет!

Reading time5 min
Views23K
Привет, Гиктаймс! Скажите честно, знакомы ли вы с «пасхальными яйцами» в IT, и, если да, то находили ли что-нибудь сами, случайно или намеренно, зацепившись взглядом за подозрительную штуку?



Вне зависимости от ответа, сегодня мы подготовили для вас подборку шуток и закладок от разработчиков в наших продуктах.
Хватайте корзинку, сейчас начнём собирать яйца.
Total votes 33: ↑27 and ↓6+21
Comments20

Справочный центр Selectel: интерфейс, техническая реализация и возможности

Reading time8 min
Views2.4K

Каждой предоставляемой услугой Selectel можно управлять в личном кабинете — панели управления. Многими нашими продуктами также возможно управлять через запросы к API. Инструкции по работе с продуктами и документация API доступны в едином справочном центре.

Основная идея справочного центра — предоставить нашим клиентам возможность в любое удобное для них время самостоятельно найти ответы на большинство интересующих их вопросов об услугах Selectel.

Далее расскажем о том, как мы изменили подход к подготовке документации и обновили внешний вид базы знаний.
Читать дальше →
Total votes 25: ↑24 and ↓1+23
Comments2

Такие разные документы: конструкторские vs. user-oriented

Reading time3 min
Views2.1K
Моим любимым русским техническим писателям посвящается

Работа технического писателя – создавать документы на программные продукты, в основном всевозможные руководства пользователя. Разработка документа – дело непростое. Есть очень много подходов и практик. Например, технические писатели в научно-производственных предприятиях часто пишут по ГОСТам или другим отечественным стандартам. Их цель – точно и верно описать продукт. А technical writers в международных компаниях пишут по style guides (Microsoft Manual of Style, например). В этом случае цель, скорее, донести до пользователя, как продукт работает. Здесь фокус смещен с продукта на читателя.

Мне довелось побыть техническим писателем в разных местах, с разными правилами и политиками. Оглядываясь назад, могу сказать, что даже в НИИ тексты можно переориентировать на конечного пользователя, и документы от этого выиграют. Но в ГОСТах про это не пишут. А style guides, во-первых, на английском, а во-вторых, не афишируются в отечественных конторах типа НПП, КБ, и пр. Поэтому есть явная нехватка информации. Я попробую ее восполнить.
Читать дальше →
Total votes 8: ↑7 and ↓1+6
Comments18

Как сделать текст легче

Reading time6 min
Views5.2K

В прошлой статье я обещала, что расскажу, как сделать документы легче для восприятия. Есть два основных направления: текстовка и структура документа. Сегодня поработаем с текстами. Технические документы на русском читаются особенно тяжело, и добиться легкости в них сложнее, чем в английском. Как можно исправить многословные, громоздкие документы? Давайте попробуем сделать их конкретнее, проще, короче, и последовательнее.

Читать дальше →
Total votes 19: ↑18 and ↓1+17
Comments35

Radio-U #10

Reading time1 min
Views370
Total votes 22: ↑15 and ↓7+8
Comments32

«Сделайте мне красиво!» Выпуск №36

Reading time1 min
Views2.2K
Вашему вниманию очередной выпуск подкаста о веб-разработке «Сделайте мне красиво!»

Show notes:



Наши ссылки: RSS и лента на rpod.ru
Total votes 3: ↑2 and ↓1+1
Comments0

Firefox 3 + Google Docs

Reading time1 min
Views446
Для меня остается загадкой почему третий лис так косячно работает с Google Docs.
При вызове контекстного меню по правому клику на папке или файле и выборе «Переместить в» страницу, не побоюсь этого слова, просто перемешивает. Переместить документ удается только при помощи драга и дропа)
Никто с подобными проблемами не сталкивался?



UPD:
Временное решение проблемы by BmW:
Вызываем менюшку перемещения в верхнем меню один раз после запуска гуглдокс, далее оно успешно вызывается из контекстного.
Total votes 8: ↑5 and ↓3+2
Comments28

5 способов занять боковую панель в Firefox

Reading time2 min
Views8.4K
Мало кто задумывался о том, что боковую панель в FireFox можно использовать для достаточно полезных вещей. В этой статье показаны 5 способов, которыми можно полезно занять место в Sidebar'е.
Читать дальше →
Total votes 23: ↑17 and ↓6+11
Comments25

Легкий Linux дистрибутив для кофейников из Windows

Reading time5 min
Views92K
Выбор легковесной и быстрой OC на базе Linux

С Windows я уже давно и поэтому хочешь-не хочешь, а привыкаешь к тому, чем пользуешься каждый день. После я заметил, что для работы мне в 90% случаев хватает связки Opera + Google Docs + Skype. В Windows меня все больше раздражало время загрузки и «разгрузки» (при выключении). Общая скорость работы системы.

Поэтому я поставил себе задачу найти легковесную ОС, которая бы удовлетворяла следующим параметрам:
— быстро грузиться и выгружаться
— легко устанавливаться, как для чайничков
— сразу подхватывать WiFi карточку и сеть (скрытая Wi-Fi сеть с WPA шифрованием)
— иметь возможность установки Оперы без лишних проблем (или из-коробки)
— поддержка русского из-коробки (ну или с простой доустановкой)

Дополнительными плюсами были бы (из коробки):
— установленный Skype
— просмотрщик PDF документов.
— чистый и минималистичный интерфейс (В Windows вместо Explorer стоит порт Blackbox — BBlean)

В Windows я ориентируюсь неплохо, а с Linux практически никогда не сталкивался, поэтому фразы стиля «Выберите файловую систему: Ext2, Ext3, Ext4, ReiserFS, XFS» вводят меня в легкий транс.
Читать дальше →
Total votes 102: ↑72 and ↓30+42
Comments184

Русская документация по PHP?

Reading time1 min
Views3.1K
Зашёл сегодня на официальный сайт, и не нашёл там русской документации в онлайне…
На странице загрузки русского также нет…

Диверсия? Или давно никто не обновлял, они и потёрли?

P.S.: В настройках сайта русского языка также нет…
Total votes 16: ↑7 and ↓9-2
Comments14

Документирование шаблонов

Reading time3 min
Views2K
Документация — это хорошо! Она позволяет экономить время, и гармонично работать людям в команде. Встроенная в код документация — вдвойне хороша, она находится там где она нужна и не надо далеко ходить чтобы ее написать.

Под катом пара наглядных примеров документации к шаблонам.


Читать дальше →
Total votes 48: ↑32 and ↓16+16
Comments27

Ruby NoName Podcast S04E06

Reading time1 min
Views672

Подкаст


Rpod

Новости


Errbit — opensource error catcher совместимый с Airbrake API
Ruby style guide
Jbuilder от DHH
GC in Ruby 2.0
Документация по Rails, Ruby-core и Ruby stdlib
Валидация на грани фола — статья на харбре про валидацию
23 марта вышел Factory Girl 3.0
17 марта вышел Rspec 2.9.0
Читать дальше →
Total votes 27: ↑20 and ↓7+13
Comments11

Система online документации для JavaScript — ADWiki

Reading time1 min
Views11K


Ссылочки


Что ADWiki умеет:
  • Парсить файлы Вашего проекта описанные на jsdoc
  • Поднимать сайт с чистеньким дизайном на bootstrap
  • Организовывать на сайте небольшой блог, где Вы сможете дополнять документацию статьями о проекте


Читать дальше →
Total votes 37: ↑34 and ↓3+31
Comments8

Применяем github actions для CI и автоматическая публикация на npm

Reading time3 min
Views15K

Github actions


Привет, Хабр. Это статья о том как автоматизировать ваш проект с помощью github actions.
Автоматизация будет делиться на:


  • CI — над каждым коммитом будут проведены тесты
  • Publish — при релизе публикуем версию в npm
Читать дальше →
Total votes 12: ↑8 and ↓4+4
Comments4

.NET docs what's new (December 2019)

Reading time2 min
Views1.1K
Welcome to what's new in .NET docs for December 2019. Listed below are some of the recent docs we've published. Find more in the full article below.

.NET Core


New articles



Read more →
Total votes 5: ↑5 and ↓0+5
Comments0

Что новенького в нашей документации по .NET (за декабрь 2019)

Reading time1 min
Views3.9K
Добро пожаловать в «Что новенького в нашей документации по .NET (за декабрь 2019)». Ниже перечислены некоторые из недавно опубликованных нами документов. Узнайте больше в полной статье ниже.

.NET Core


Новые статьи



Читать дальше →
Total votes 10: ↑9 and ↓1+8
Comments7