Pull to refresh
  • by relevance
  • by date
  • by rating

Запустилась Дока — опенсорсный справочник по веб-разработке

Яндекс.Практикум corporate blog Website development *CSS *JavaScript *HTML *
Дока — это опенсорсный справочник с документацией, который веб-разработчики пишут для веб-разработчиков. Цель Доки — сделать документацию по веб-разработке практичной, понятной и не скучной.

Это открытый проект, внести вклад в него может каждый. Контент и код Доки лежат на GitHub, правила участия, обсуждения и ревью проходят открыто для всех желающих.

Яндекс.Практикум поддерживает работу редакции Доки.


Читать дальше →
Total votes 29: ↑26 and ↓3 +23
Views 9.7K
Comments 77

Mozilla пытается переложить на сообщество поддержку проекта MDN после массового увольнения сотрудников

ITSumma corporate blog Website development *Open source *Personnel Management *Technical Writing *

Разработчик популярного браузера Firefox, компания Mozilla, пытается переложить на сообщество поддержку проекта Mozilla Developer Network (MDN) — единой площадки публикации документации для веб-разработчиков. Для этих целей компания Mozilla учредила организацию Open Web Docs.

MDN описывает типы поддерживаемых в современных браузерах технологий, включая JavaScript, CSS, HTML и различные Web API. Проект оказался на грани закрытия по вине самой Mozilla.

Читать далее
Total votes 29: ↑27 and ↓2 +25
Views 7.6K
Comments 17

РБК: Производители электроники испытывают проблемы с документами для ФСБ и вынуждены получать нотификации в Казахстане

Legislation in IT IT-companies

Некоторые крупные производители смартфонов для российского рынка начали получать документы-разрешения для властей в Казахстане из-за проблем с их получением в России, сообщает РБК. Речь идёт о нотификациях, которые нужны при импорте товаров, в которых содержатся элементы шифрования и криптографии — смартфонов, планшетов, ноутбуков, серверов и другой техники.

Читать далее
Total votes 14: ↑12 and ↓2 +10
Views 2.9K
Comments 0

Бизнес увидел риски в законопроекте об электронных дубликатах документов

Data storage *Legislation in IT

Поправки к внесенному в Госдуму законопроекту «Об информации, информационных технологиях и о защите информации», которые касаются хранения документов, не выполняют первоначальные цели и нуждаются в корректировке, считают представители бизнеса. Они отмечают, что исполнения закона в его текущем виде не приведет к сокращению расходов на обслуживание и создаст барьеры для кредитных организаций.

Читать далее
Total votes 7: ↑7 and ↓0 +7
Views 849
Comments 0

NPJ — эффективное средство для ведения проектов и документации

System administration *
Ведение документации на свою рабочую сеть давно стало правилом хорошего тона для любого уважающего и считающего себя профессионалом системного администратора. Дело здесь вовсе не в служебных обязанностях, а скорее в прямой необходимости.

Читать дальше →
Total votes 16: ↑14 and ↓2 +12
Views 6.3K
Comments 27

Техническая документация: сервера и сети.

System administration *
Приходя на новое место работы, каждому системному администратору хочется получить пакет исчерпывающей технической документации. И первые по важности в этом пакете документы об устройстве сети и серверов.
Читать дальше →
Total votes 38: ↑33 and ↓5 +28
Views 55K
Comments 13

Документация – экономия времени или его бесполезная трата?

System administration *
Искусство организации рабочего времени (time-management) последнее время обретает всё большую популярность и если раньше это в основном относилось к менеджерам различного уровня, то теперь накопленные знания начинают применяться и в других областях деятельности компании.
Читать дальше →
Total votes 22: ↑17 and ↓5 +12
Views 23K
Comments 18

Использование asciidoc для документирования проекта

Project management *
Когда перед нашей фрилансерской группой встала задача документирования проекта, были сформулированы следущие требования:
  • Как известно, программисты, обычно, не очень любят писать документацию… поэтому чем проще и комфортнее будет её писать, тем больше вероятность, что её таки будут писать.
    • Поскольку мы работаем из дома, то должна быть возможность писать документацию локально, на своей машине.
    • Чтобы это было делать комфортно, нужна возможность использовать для этого любимый текстовый редактор, никаких форм на вебсайтах а-ля вики или систем заточенных под конкретный редактор/IDE.
    • С доступом в инет у всех по-разному, и чтобы исключить ситуацию, когда документация небыла написана исключительно потому, что когда появилось настроение её писать по закону подлости отвалился инет — для написания документации не должен требоваться инет.
  • Документация должна быть доступна всем, кто работает над проектом. Это включает как возможность читать её через вебсайт так и работать с ней как с обычными локальными файлами.
  • Желательно, чтобы документация поддерживала какой-нить язык разметки и гиперссылки, чтобы её было удобно читать.
  • Возможность редактировать документацию из браузера (а-ля вики) желательна, но не очень важна (разработчики будут работать с файлами, так что эта фича может пригодиться в основном клиенту, который врядли будет напрямую править документацию).

Читать дальше →
Total votes 29: ↑27 and ↓2 +25
Views 20K
Comments 22

Забытая фаза проектирования

Lumber room
Сейчас почти в каждой статье про web 2.0 и стартапы среди рекомендаций можно увидеть совет: бросьте долгие раздумья и пред-проектную документацию — делайте проект! И очень часто этот совет воспринимается буквально, первые строчки кода появляются еще до того, как идея окончательно сформируется. Что в итоге? А в итоге ядро системы за весь период разработки переписывается раз по 15, не говоря уже о фронтенде. Как следствие проект который был задуман как 1-2х месячный растягивается на пол-года — год. А код превращается в сборище багов.

Что же сделать что-бы этого избежать и при этом не заниматься планированием по пол-года?
Читать дальше →
Total votes 23: ↑19 and ↓4 +15
Views 895
Comments 57

Основы программирования под Битрикс

CMS *
Основы программирования под Битрикс

В статье Как создать раздел сайта под управлением «1С Битрикс: Управление сайтом». Основы программирования под Битрикс даётся краткий обзор шагов, необходимых для создания раздела сайта под управлением «1С-Битрикс: Управление сайтом 6.5». Статья может служить отправной точкой для начала изучения принципов программирования под Битрикс. В тексте статьи содержатся ссылки на соответствующие разделы документации и страницы официальных учебных курсов с более детальной информацией.

Дабы избежать нападок в стиле «статья заказная», «автор не разбирается», сразу предупрежу, что статья написана на основе личного опыта авторов по освоению Битрикс-программирования и является конспектом внутреннего семинара компании. Также при создании статьи очень помогли посетители форума офсайта Битрикса, указавшие на неточности.

Читать дальше →
Total votes 21: ↑9 and ↓12 -3
Views 32K
Comments 15

Документация о вашем предприятии

Lumber room
Обед был омрачен необходимостью разъяснять новому какому-то начальнику-князьку смысл и принципы деятельности некоторых отделов. Высшее начальство, как водится, ни черта не знает о реальных делах своих подчиненных — но хотя бы пожелало разобраться в этот раз. Неприятность состояла в том, что я принципиально за обедом о работе забываю, а тут — надо.
Читать дальше →
Total votes 5: ↑5 and ↓0 +5
Views 371
Comments 6

JavaScript. Создание объектов

JavaScript *
JavaScript предоставляет разработчикам возможность создавать объекты и работать с ними. Для этого существуют следующие приёмы:
  • Оператор new
  • Литеральная нотация
  • Конструкторы объектов
  • Ассоциативные массивы

Читать дальше →
Total votes 56: ↑42 and ↓14 +28
Views 102K
Comments 81

Проект Samba получил спецификации по протоколам от Microsoft

Configuring Linux *
Проект Samba получил спецификации по сетевым протоколам, используемым в серверных вариантах Windows.

Это стало возможным в результате решения Еврокомисии о предоставлении спецификаций протоколов конкурентам. Решение было принято еще в марте 2004, но МС подало аппеляцию, которую суд отклонил в сентябре этого года.

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

Проект Samba: http://www.samba.org/
Пресс-релиз на английском языке: http://samba.org/samba/PFIF/
История судебного процесса: http://samba.org/samba/PFIF/PFIF_history.html
Текст соглашения: http://samba.org/samba/PFIF/PFIF_agreement.pdf
Total votes 33: ↑31 and ↓2 +29
Views 674
Comments 41

ТЗ: макеты или текст?

Website development *
В заметке ТЗ для web-разработчика автор пишет:
считаю что одно из самых правильных способов подачи информации есть графический, т.е. лучше один раз увидеть, чем сто раз услышать.

Никак не комментируя заметку в целом, хотелось бы сделать несколько замечаний по поводу разных способов представления информации в ТЗ и не только в нём.

Читать дальше →
Total votes 2: ↑3.5 and ↓-1.5 +5
Views 8.8K
Comments 24

Техническое задание — To be or not to be?

Project management *Technical Writing *
Прочитал статью Станислава Малкина — Для заказчиков: если нет ТЗ.

Вообщем-то написано всё грамотно, последовательно и понятно.
Сделан напрашивающийся вывод — техническому заданию быть — to be! (Однозначно! Я сказал! Жириновский)

И быть ему, по мнению Станислава, следует по трем вариантам:
  1. ТЗ написано самим заказчиком.
  2. ТЗ написано разработчиком заказанной системы.
  3. ТЗ написано профессиональным составителем ТЗ.


Я думаю что первый вариант имеет право на жизнь только если у заказчика уже имеется опыт написания ТЗ, основанный на втором и/или третьем варианте.
Пока пропустим второй вариант и обратимся сразу к третьему. Насколько можно судить по статье — Станислав считает этот вариант самым приемлимым, особенно для начинающих заказчиков. Однако я вижу гораздо больше минусов чем указано в статье (собственно единственный указанный минус — дополнительные расходы на написание технического задания):

Читать дальше →
Total votes 1: ↑1 and ↓0 +1
Views 8K
Comments 64

Мой знакомый разработчик

Website development *
Я работаю с удивительным человеком. Каждый раз, когда я смотрю в bugzill'у или проверяю почту, я им поражаюсь. Иногда мне кажется, что он мог бы стать неплохим писателем. Во всяком случае графоман из него отличный.

Этот разработчик принимает документирование очень близко к сердцу.
Что же тут такого удивительного?
Total votes 64: ↑59 and ↓5 +54
Views 619
Comments 38

BullDoc — система разработки документации

Self Promo

Давайте знакомиться


Каждая разработка, если она хоть немного поэтичней, чем печать «hello world», требует документации. И как-то так получалось, что я начинал писать документацию и все время наталкивался на то, что мне это неудобно:


Документация в MS Word (Open Office) не имеет подсветки кода, держит все в одном длинном документе, его не положишь в систему контроля версий для отслеживания изменений. Такой документ невозможно без лишних трудностей сохранить в html-коде, который будет размещён на сайте.


Microsoft HTML Help Compiler позволяет все хранить в тексте, но не имеет подсветки синтаксиса, документ нельзя собрать в связанные html-страницы для выкладывания на сайт без active-x компонента

Формат Docbook тоже близок к желаемому, но XSLT трансформации сложны, подсветка синтаксиса — хоть и решаемая, но проблема.

PHPDocumentator нацелен на написание документации в виде комментариев к коду. Да, он поддерживает подключение нескольких страниц чистой документации к тому, что получилось (кажется это называется там термином тюториал). BullDoc направлен на написание документации в чистом виде — в виде книжки. Опрятной нормальной книжки с главами, разделами, оглавлением и индексом. То, что получается на выходе из PHPDoc это рабочий инструмент, никак не документация для конечного юзера.

В результате появился небольшой скрипт для документации, который был причесан, задокументирован и предложен обществу.

Читать дальше →
Total votes 41: ↑35 and ↓6 +29
Views 1.6K
Comments 50

документация android оффлайн

Lumber room
Если для кого то будет полезным, выкачал Teleport'ом документацию по андроиду.
рапида
p.s. не говорю, что там все красиво, css немного дал о себе знать в меню, а во всем остальном нормально.
Total votes 7: ↑6 and ↓1 +5
Views 313
Comments 6

Предпроектная документация: что это и почему она так важна?

Project management *
Среди моих знакомых нет ни одного, кто любил бы писать технические задания или что-то вроде этого. Чертить на салфетках планы захвата вселенной, собирать лэйауты из разноцветных стикеров, шлифовать концепцию в голове и на словах – это все любят и умеют делать, а вот сесть и как следует записать…
Меня, например, любой шаблон серьезного документа погружает в глубочайшую тупку.

У моих знакомых очень много хороших идей, но с таким подходом, слава богу, что дело редко доходит до производства. Почему? Плохо продуманные проекты редко бывают успешными. Либо команда по уши вязнет в тех работах, которые не были видны в начале, либо получается кривоватый, плохо приспособленный к жизни гоблин. Плохо масштабируемый к тому же.

Читать дальше →
Total votes 55: ↑50 and ↓5 +45
Views 9.1K
Comments 52