Вчера социальная сеть ВКонтакте обновила документацию для разработчиков и запустила баг-трекер.
Под катом обзор новых возможностей документации.Читать полностью »
Рубрика «документация» - 10
«ВКонтакте» обновил документацию API
2013-03-22 в 15:16, admin, рубрики: vk api, Веб-разработка, Вконтакте, Вконтакте API, документация, метки: vk api, Вконтакте, документацияПеревод сайта разработчиков Android на русский
2013-01-31 в 10:58, admin, рубрики: android, Google, документация, Разработка под android, метки: android, Google, документация Как известно, у Android есть официальный сайт разработчиков. Не так давно он претерпел полный редизайн.
Читать полностью »
Specification By Example – BDD для прагматиков
2013-01-23 в 8:22, admin, рубрики: bdd, Specification By Example, автоматизированное тестирование, Блог компании «ETNA Software», документация, документация это легко, разработка, тестирование, управление проектами, метки: bdd, Specification By Example, автоматизированное тестирование, документация, документация это легко, разработка, тестирование, управление проектами 
На Хабре довольно много упоминаний о BDD. К сожалению, статьи, которые я читал, так и не дали мне ответа на вопрос «а зачем мне все это нужно?» Ответ пришел с неожиданной стороны. Когда я всерьез занялся вопросом автоматизации приемочного тестирования, мне под руку попалась книга Gojko Adzic (не уверен в транскрипции, поэтому не стал переводить имя автора) Specification By Example.
Читая ее, я не уставал удивляться: каждая новая глава описывала шишки, которые я набивал на своем личном опыте, и предлагала решения аналогичные или лучшие, чем те, к которым я приходил сам методом проб и ошибок.
Эта статья – первая в цикле «BDD для прагматиков». В ней описаны ключевые элементы наиболее эффективного, на мой взгляд, процесса разработки коммерческого ПО в современных условиях. Два продолжения будут посвящены работе со SpecFlow и автоматизации приемочного тестирования.
Читать полностью »
Работая в интересах Будущих Разработчиков
2012-11-20 в 15:09, admin, рубрики: cooperations, rails, ruby on rails, документация, командная работа, культура кода, паттерны, проектирование, Проектирование и рефакторинг, рефакторинг, Совершенный кодУспешный программный продукт обычно проходит за свою жизнь через руки множества разработчиков. Вы — лишь одно из звеньев в цепочке опекунов вашего проекта, и каждая строчка кода, которую Вы написали — это оставленный Вами артефакт, который когда-нибудь будет изучаться Будущим Разработчиком. Также, как Вы унаследовали решения разработчиков, которые были до Вас, другие разработчики унаследуют решения, которые Вы делаете сегодня. Они получат от нас в наследство все наши недоразумения, срезанные нами углы, примененные нами недопонятые паттерны и техники, наше невнимание к деталям, нашу лень, наши изменения, сделанные на скорую руку, наших скелетов в шкафах, наше грязное белье. И гораздо реже — выгоду от нашей дисциплинированности, наших обсуждений и подготовок.
Trac и его друзья Gitolite, Nginx и UWSGI
2012-11-18 в 13:59, admin, рубрики: gitolite, nginx, trac, uwsgi, документация, инструкция по установке, Программирование, разработка, управление проектами, метки: gitolite, nginx, trac, uwsgi, документация, инструкция по установкеВсем наверно известен замечательный OpenSource проект Trac, позволяющий организовать рабочий процессы при разработке программного обеспечения. Однако его развертывание и настройка является не простой задачей. Информация в интернете разрозненная и часто уже устаревшая. В этом я смог сам убедиться настраивая Trac интегрированный с Gitolite на связке Nginx+UWSGI.
После небольшой увертюры с бубном у меня родился этот документ являющийся практически пошаговой инструкцией по развертыванию проекта Trac. Надеюсь это пригодится кому-нибудь еще.
Читать полностью »
Вопросы «Что? Где? Когда?» в функциональных требованиях
2012-11-17 в 21:54, admin, рубрики: Анализ и проектирование систем, аналитика, документация, интеграция, разработка, метки: аналитика, документация, интеграцияВзгляд на функциональные требования к интеграционной системе
Наверное, всем разработчикам приходилось сталкиваться как с замечательными, так и с отвратительными требованиями к системе. В каждой отрасли своя специфика и определить универсальные стандарты можно только на бумаге. А когда по этим стандартами пишутся реальные требования, мы получаем стостраничные документы «ни-о-чем», которые в лучшем случае не мешают разработке, а зачастую – вводят в заблуждение относительно реальных потребностей пользователя и заказчика.
Поэтому, в этом посте я постараюсь кратко выразить свою мысль относительно определения требований именно к интеграционным системам. Прошу в ином контексте идею не рассматривать, иначе пост покажется бредом, а я – идиотом.
Читать полностью »
Недокументированные изменения или PHP 5.4 и перегрузка функций
2012-10-05 в 5:55, admin, рубрики: php, php 5.4, документация, недокументированные возможности, метки: php 5.4, документация, недокументированные возможностиКак это было
Не так давно сталкнулся с одной проблемой, возникшей при переезде на php 5.4. Задача состояла в тестировании функционала, который использовал родные функции. К слову, Fumocker отлично справляется с этой задачей, позволяя в тестах переопределять встроенные функции. Я написал пачку тестов и запустил их локально. Все тесты прошли успешно. Отлично! Задача была сделана и я был в полном счастье, пока не добавил проект в travis-ci. И? Сборка была сломана под php 5.4, когда под 5.3 всё светилось зелёным.
Именно этот факт навел меня на мысль, что между 5.3 и 5.4 должна быть разница в перегрузке функций.
Читать полностью »
Делаем учебник или документацию за час на Сфинксе
2012-10-02 в 20:31, admin, рубрики: python, документация, разработка, учебник, Учебный процесс в IT, метки: python, документация, учебникЯ веду курс веб-программирования. Когда учишь людей, поговорка «сапожник без сапог» к тебе относиться не должна: ты должен делать всё без видимых усилий и быстро. Учебник должен делаться легко и просто, и выглядеть хорошо.
В общем, если вам нужно сделать документацию, учебник или просто набор текстов с иллюстрациями, то вам нужен Python Sphinx, и здесь я расскажу, как быстро его настроить и использовать.
Система online документации для JavaScript — ADWiki
2012-09-28 в 11:33, admin, рубрики: autodafe, docs, javascript, node.js, документация, метки: autodafe, docs, javascript, node.js, документация 
Ссылочки
- Живая демонстрация
- Код задокументированного файла из демки
- Да и вобще весь сайт autodafe.ws полностью работает на ADWiki
- Инструкция по установке ADWiki
- Проект на GitHub
Что ADWiki умеет:
- Парсить файлы Вашего проекта описанные на jsdoc
- Поднимать сайт с чистеньким дизайном на bootstrap
- Организовывать на сайте небольшой блог, где Вы сможете дополнять документацию статьями о проекте
Приобретение и надлежащее оформление прав использования программного обеспечения
2012-06-27 в 11:33, admin, рубрики: договор, документация, копирайт, право, Программирование, Программное обеспечение, Софт, метки: договор, документация, право, программное обеспечениеМногие пользователи Хабра являются либо приобретателями авторских прав на программное обеспечение либо продавцами таких прав.
В своей первой статьей на Хабре я хотел бы совсем вкратце поделиться своими соображениями относительно приобретения и надлежащего оформления авторских прав на программное обеспечение в условиях действующего законодательства Российской Федерации.
Побудило к написанию настоящей статьи моя ежедневная практика и фактически непонимание окружающих, в том числе специалистов казалось бы, очевидных вещей при оформлении договоров по приобретению прав на использование программного обеспечения.
Читать полностью »