Метка «документирование»

Quick Help научился брать документацию из комментариев:

Quick Help для своего кода в XCode 5
Читать полностью »

Знакомство каждого человека с компьютером рано или поздно подходит к редактированию документов.
А вот дальше, как говориться, есть варианты.

Скажем нет форматированию пробелами и энтерами
Человек может использовать компьютер лишь как печатающую машинку, у которой все средства форматирования сводятся к вставке лишних пробелов да переводу каретки на нужный интервал.
А может и научиться правильно форматировать документ используя хотя-бы необходимый минимум пробелов функциональности редактора.

Вот те, кому надоело видеть/выковыривать из текста лишние пробелы, кому необходимо обеспечить совместную разработку документа с хранением в git/svn и много другого полезного — могут нажать кнопку ниже, чтобы прочитать немного больше про замечательный редактор Lyx.
Читать полностью »

Преамбула

Всем знакома ситуация, когда на весь зоопарк из компьютеров, ноутбуков, планшетов, копировальной техники, серверов, активного сетевого оборудования и т.д. всего один админ. Он альтруист, вы не подумайте. Он любит свою работу. Он разбирается в теме. Он эффективен и глаза горят. Но как ни крути, когда вся ИТ функция предприятия, пусть даже небольшого, завязана на одного человека – это такой нехилый эксплуатационный риск. Я всегда задаю вопрос: «Что будет, если он, например, заболеет или уволится одним днем без объяснения причин?» Сколько дней вы продержитесь, пока найдете человека, который будет разбираться во всем этом зоопарке с нуля? Нет, ну серьезно? Представьте, что завтра этого человека не будет, а вас закончились лицензии, интернет, бумага в принтере и умер сервер с базой данных клиентов.
Читать полностью »

Появился пост, в комментариях к которому (какая ирония) было много мнений,
что самый лучший код — self-documenting и все такое.

Я, в общем, не претендую на гуру и ниже излагаю только свое собственное мнение. Оно кардинально отличается от мнения, что лучший коммент — этот тот, которого не было, но содержит за собой непотопляемые практические аргументы.

Кто желает подискутировать — прошу к столу под кат.
Читать полностью »

Частенько, по долгу службы в том числе, приходится писать всякие ТЗ, а так же вникать и (командовать) создавать документацию по продуктам и решениям. ТЗ — для отношений с клиентом, документация — для разработчиков. Основные принципы, которые должны быть, коротко, под катом.
Читать полностью »

Уровень: начинающим, продолжающим, ленивым

Что, опять? Но зачем!?

О документации сказано уже много, в том числе и на хабре, где я нашел несколько статей. Однако те статьи которые я смотрел (раз, два, три, четыре) отвечают на вопросы зачем и что нужно документировать. Я же хочу привести два простых примера показывающих как, а также демонстрирующих, что документация может быть мягкой и шелковистой легкой и приятной.
Читать полностью »

Несколько ранее я уже писал о появлении нового PHP-движка для автоматической генерации документации Docblox (тут и тут). Сегодня я с удивлением обнаружил, что теперь все нововведения из Docblox перекочевывают в PHPDocumentor. Предыдущая ветка PHPDocumentor 1.х теперь считается устаревшей, а основные нововведения будут появляться в ветке 2.х. Также обновлен официальный сайт phpDocumentor.Читать полностью »


https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js