Когда на работе просят написать какую-то документацию по какому-либо модулю, то у меня выходит не более 20 страниц. Недавно нас попросили разработать документ oAuth для сайта клиента, и у меня выгло 15 страниц с расписыванием всех методов, которые нам понадобятся и с примерами использования. Я потом отправил этот документ парню, с которым работаю (он канадец и знает английский на много лучше меня), чтобы он исправил мои косяки и добавил свои может идеи.
После его редактуры у нас получилось 18 страниц текста. Мы отправили этот документ клиенту и через неделю узнали, что нашу спецификацию зарубили. Вроде бы как другая компания должны была работать над oAuth спецификацией.
На этой неделе мы получили эту спецификацию, а сегодня я ее скачал себе на iPad, чтобы можно было по дороге домой почитать. Более 1000 страниц английского текста. Теперь мне нужно прочитать этот текст и понять, что от нас хотят. Причем сделать я должен это до пятницы. Завтра будет совещание в обед и я должен иметь хоть небольшое представление о том, над чем мы работаем, а в пятницу нужно уже иметь полное представление о спецификации.
Да, мне еще учится и учится воду лить. Более 1000 страниц мануала - это конечно же жестоко. Не удивительно, что наш вариант не рассматривали, мы так писать не умеем.
Понравилось? Кликни Лайк, чтобы я знал, какой контент более интересен читателям. Заметку пока еще никто не лайкал и ты можешь быть первым
> Да, мне еще учится и учится воду лить.
А мне казалось, вы умеете ))))))))
- Кстати, французский ваши канадцы знают?
- Скажите, вы на английском тоже с ошибками пишете?
- Простите, если что. Раз тема "треш", значит "трешим")))
А я то думал как такие доки пишутся. Работаю сейчас с одной платной системой (не буду говорить название). Документация на 700мб (только что специально посмотрел). Найти в ней что-то это довольно творческое занятие. В лучшем случае за пару часов из 3-4 документов удается извлечь более-менее адекватное описание какого-либо функционала.
Михаил, как при таких раскладах вы все успеваете ?
И в интернете посидеть, и почитать что-то для себя, и по работе, да и работать, в конце-концов.
Сколько вы в день спите ?
Мне это всё напомнило ситуацию с моей магистерской диссертацией. Когда расчётов и нужной теории было на 60 страниц, а требовалось 100. Сколько бы я не ругался с научруком, пришлось налить ещё 40 страниц бреда. Видимо не только в России подобное любят :)
Это консалтинговая фирма разрабатывала документацию?
Я не знаю, кто писал документ.
сталкивался с подобным, вроде дока по Adobe Premiere
больше похожа на учебник с фотками, причем бумага даст фору любой книжке
Заметил немного:
"выгло" => "вышло"
Человек не способен на такое) Это чужеродный нам искусственный разум, который хочет захватить нашу планету)
Хотите найти еще что-то интересное почитать? Можно попробовать отфильтровать заметки на блоге по категориям.
Программист, автор нескольких книг серии глазами хакера и просто блогер. Интересуюсь безопасностью, хотя хакером себя не считаю
Copyright © 2024 Михаил Флёнов. Тираж 1 штука. Отпечатано на ноутбуке. А за права отвечаю, или постараюсь.
А здесь еще и копирайт поставлю: Professional Web Development.
