Разработка технической документации для API

100 000 руб. за месяц • наличный расчёт, безналичный расчёт, электронные деньги
19 сентября 2014, 14:33 • 9 откликов • 75 просмотров
В нашей компании разрабатывается HypermediaAPI и пришло время открыть
его нашим клиентам, но так случилось что наша техническая документация которая
описывает ресурсы и способы взаимодействия сильно устарела. И мы решили создать
новую документацию и для этих целей нам нужны люди которые умеют и хотят
заниматься кропотливой работой создавая для нас технический документ.


Этим документом будут
пользоваться отделы разработки крупных американских, канадских и немецких
компаний (Крайслер, Ауди, Митсубиси, Тойота). Документ должен быть написан на
английском языке. Мы прекрасно понимаем, что написать технический документ на
не родном языке без ошибок достаточно сложно, поэтому коррекцию правописания и
стилистику мы берём на себя.


Мы рассчитываем,
что этот документ будет создан для нас в срок от двух до трёх месяцев одним
либо несколькими людьми, работающими удалённо.

Для того, чтобы мы серьёзно начали говорить о работе для этого необходимо
выполнить следующие условия:


  • Подписать NDA (Non-disclosure agreement)


  • Быть готовым работать над документацией по 8 часов
    в день с ежедневной отчётностью


  • Иметь опыт написания технических документаций на
    английском языке

    Иметь
    представление о том, что такое HypermediaAPI (пример Яндекс.Диск API, если я не ошибаюсь)



Работу мы предполагаем построить следующим образом:
Я и мои
коллеги расскажу о том, чем мы занимаем и для каких целей служит наш API.


Мы расскажем о том, как он устроен и
какие принципы работы разработали наши архитекторы. Разобьём всё это на
части и составим план того, как покрыть техническим описанием каждый нюанс
работы с нашим API. Когда работа наладится
наши разработчики по просьбе будут готовить примеры запросов и ответов для
добавления их к документации.


Оплачивать работу
мы будем в соответствии с договорённостями, но не чаще чем раз в две недели и
не реже чем раз в месяц.