Тухлый Александр (0xd34df00d)

*opensource *programming
Жуйк, как пишутся доки?
Я вот хочу написать техническую документацию по написанию плагинов ваще и по расширению IM'а в личкрафтах, например. Но я-то создатель и совершенно не представляю, что понятно и очевидно, о чем рассказывать, и так далее. Как вообще пишутся техдоки? Кто их пишет?

Реквестирую истории успеха.

#1199246
from Azoth_primary, 6 months ago

← All messages

Replies (11)

Post a reply (xmpp)

@nya:
очень просто. поставь свежий линукс, и какой нить git clone lecchraft
Начни типа писать плагин.
сразу поймешь о чем писать доку — зависимости, грабли и тп.
#1199246/1
from Gajim, 6 months ago
@vreditel:
Скачать готовый и посомтреть :) можно ГОСТы почитать по написанию сопроводительной документации )))
#1199246/2
from ))), 6 months ago
@0xd34df00d:
@vreditel Готовую документацию?
Дык я регулярно ей пользуюсь — Qt, Boost, и так далее. Как-то не очень помогает.
#1199246/3
from web, 6 months ago, in reply to /2
@0xd34df00d:
@nya Не получается. Все грабли, на которые я наступал или забывал, уже документированы. С остальным у народа, видимо, напряг.
Я сейчас попросил чувака, который их тоже пилит, записывать затруднения, возникающие при пилении. Но это как-то странный выход, что ли.
#1199246/4
from web, 6 months ago, in reply to /1
@nya:
@0xd34df00d ну прогони doxygen и вот тебе нормальная дока по апи личкрафтов
#1199246/5
from Gajim, 6 months ago, in reply to /4
@vreditel:
@0xd34df00d как человек, регулярно пишущий руководства по эксплатации могу сказать, что в подобные доки нужно писать абсолютно всё, даже то, что никогда не вызовет у тебя затрудений — у кого- вызовет. Просто описать каждый шаг.
#1199246/6
from ))), 6 months ago, in reply to /3
@nya:
@vreditel это туториал. дедфуд, напиши просто пару туториалов
#1199246/7
from Gajim, 6 months ago, in reply to /6
@0xd34df00d:
@nya Она не описывает, как писать, это хуйня.
#1199246/8
from web, 6 months ago, in reply to /5
@0xd34df00d:
@vreditel А мне все очевидно, я не могу даже начать писать, построить план, понять, в какой последовательности и так далее, и ваще.
#1199246/9
from web, 6 months ago, in reply to /6
@vreditel:
@0xd34df00d <juick.com> Начни примено так: Для написания плагина включите компьютер такими-то кнопками, запустите такую-то прогу, написав в консоли то и то-то, либо нажмите такую иконку на рабочем столе. Далее сочетанием клавиш создаейте новый документ. Ну и так далее. А там втянешься.
#1199246/10
from ))), 6 months ago, in reply to /9
@0xd34df00d:
@vreditel Ах ты ж блин. Что-то у меня снова пропало желание писать доки.
#1199246/11
from web, 6 months ago, in reply to /10

Тухлый Александр (0xd34df00d)

Subscribe

Replies (11)

Messages

Tags all

Search

Statistics