АМ
Коллеги, а кто может поделиться примером (ссылкой) документации к API написанной грамотным литературным языком?
Десять программистят писали интеграцию через API. Один не дочитал документацию и передал неверные параметры. И их осталось девять.
Size: a a a
2019 December 30
SR
Коллеги, а кто может поделиться примером (ссылкой) документации к API написанной грамотным литературным языком?
FM
Коллеги, а кто может поделиться примером (ссылкой) документации к API написанной грамотным литературным языком?
https://www.tarantool.io/ru/doc/1.10/dev_guide/reference_capi/
Неплохая дока, сам пользовался, чтобы понять что такое Тарантул
Неплохая дока, сам пользовался, чтобы понять что такое Тарантул
SR
Fox Mulder
https://www.tarantool.io/ru/doc/1.10/dev_guide/reference_capi/
Неплохая дока, сам пользовался, чтобы понять что такое Тарантул
Неплохая дока, сам пользовался, чтобы понять что такое Тарантул
Выглядит хорошо. Но вот такие моменты немного всё же режут.
Возврат true (правда), если есть активная транзакция.FM
Да везде бывают недочёты, мы ж не роботы.
FM
Я тут вспомнил про самый страшный недочет (факап) в документации: когда боинг при вводе новой фичи не озаботился внести изменения в документацию. В результате произошла авиакатастрофа.
FM
Не переоценивайте пользователей вашего программного обеспечения: если вы пишете не для программистов, рассчитывайте на то, что программа столкнётся с непробиваемым непониманием. Первые несколько дней или недель пользователь будет ненавидеть ваш софт, потому что «старый был не такой тупой». Чтобы этого избежать, делайте классную документацию и обучающие материалы. При установке или покупке очень навязчиво намекните, что мануалы стоит читать до начала работы с программой, а не после краха базы, потери пароля и самоконтроля.
D
Fox Mulder
Я тут вспомнил про самый страшный недочет (факап) в документации: когда боинг при вводе новой фичи не озаботился внести изменения в документацию. В результате произошла авиакатастрофа.
Мне очень нравится пояснение слова «недочёт», написанное в скобках
OR
Этой "инструкции" до этого не встречала, делюсь :)
SR
Это расширенное, дополненное и улучшенное издание?
OR
наверняка. Теперь с блютусом!
ЕД
Самый страшный факап, это когда на моем проекте агенство решило не оплачивать перевод цифр
ЕД
И в руководстве по сварке трубопровода для атомной электростанции остались цифры от футо/фунтов и единицы давления
ЕД
А сокращения переводчики автоматом поменяли на метры и кг/см2
ЕД
Я в последний момент из паранойи полез проверить
SP
Fox Mulder
Не переоценивайте пользователей вашего программного обеспечения: если вы пишете не для программистов, рассчитывайте на то, что программа столкнётся с непробиваемым непониманием. Первые несколько дней или недель пользователь будет ненавидеть ваш софт, потому что «старый был не такой тупой». Чтобы этого избежать, делайте классную документацию и обучающие материалы. При установке или покупке очень навязчиво намекните, что мануалы стоит читать до начала работы с программой, а не после краха базы, потери пароля и самоконтроля.
Золотые слова.
S
И в руководстве по сварке трубопровода для атомной электростанции остались цифры от футо/фунтов и единицы давления
Слышал, что-то такое на подрядах у NASA было.
Правда там плачевно закончилось. Космический аппарат потеряли
Правда там плачевно закончилось. Космический аппарат потеряли
ЕД
Тьфу-тьфу. У меня все закончилось благополучно. Я потом этот случай годами на конференциях рассказывал как при ёр того, почему не надо экономить на переводчиках и повторах
2019 December 31
AS
Уважаемые коллеги!
Поздравляю вас всех с наступающим 2020-м годом!
Желаю вам счастья, здоровья и удачи во всех делах!,
Поздравляю вас всех с наступающим 2020-м годом!
Желаю вам счастья, здоровья и удачи во всех делах!,