Коллеги! Возник такой вопрос.
Разрабатывается некая SDK и она готова для выпуска. Но для неё нет нормальной документации и нет человека,
который эту документацию может написать.
Правда есть нечто сгенерённое доксигеном и всё. Это сложно назвать документацией.
Стоит ли выпускаться с такой “документацией” или нужно в обязательном порядке
искать ресурсы что бы её реализовать? Насколько успешным или не успешным может
быть проект при таком раскладе?
Здравствуйте, Аноним, Вы писали:
А>Коллеги! Возник такой вопрос.
А>Разрабатывается некая SDK и она готова для выпуска. Но для неё нет нормальной документации и нет человека, который эту документацию может написать.
А>Правда есть нечто сгенерённое доксигеном и всё. Это сложно назвать документацией.
А>Стоит ли выпускаться с такой “документацией” или нужно в обязательном порядке искать ресурсы что бы её реализовать? Насколько успешным или не успешным может быть проект при таком раскладе?
Для SDK документация критична, по-моему, как и примеры использования, это kick start для новых пользователей. Зарубежные коллеги хвалят
http://www.documentationdoctor.com/, попробуйте обратиться к нему(ней?) за оценкой.
От doxygen'а в чистом виде практической пользы конечно нет. То что он генерит и так можно посмотреть в исходниках с такой же скоростью.
Конечно, можно в коде, его макросов понавставлять, и ценность увеличится.
Однако! Не знаю почему, но много кто считает что это нормально и начальство просто смотрит на факт наличия документации.
И даже думают что doxygen это круто, хотя сами такой докой не пользуются.
я бы посоветовал, давать сгенерённый хэлп, если там будут каменты то это будет неплохо. Со временем будете их добавлять и будет даже юзабельно.
Но обязательно напишите что нибудь типа Getting started, пару туториалов. Их наверное можно в хэлп тоже.
А систему в духе MSDN писать смысла нет — никто не оценит. Как это не печально.
