Разработчик популярного браузера Firefox, компания Mozilla, пытается переложить на сообщество поддержку проекта Mozilla Developer Network (MDN) — единой площадки публикации документации для веб-разработчиков. Для этих целей компания Mozilla учредила организацию Open Web Docs.
MDN описывает типы поддерживаемых в современных браузерах технологий, включая JavaScript, CSS, HTML и различные Web API. Проект оказался на грани закрытия по вине самой Mozilla.
Некоторые крупные производители смартфонов для российского рынка начали получать документы-разрешения для властей в Казахстане из-за проблем с их получением в России, сообщает РБК. Речь идёт о нотификациях, которые нужны при импорте товаров, в которых содержатся элементы шифрования и криптографии — смартфонов, планшетов, ноутбуков, серверов и другой техники.
Поправки к внесенному в Госдуму законопроекту «Об информации, информационных технологиях и о защите информации», которые касаются хранения документов, не выполняют первоначальные цели и нуждаются в корректировке, считают представители бизнеса. Они отмечают, что исполнения закона в его текущем виде не приведет к сокращению расходов на обслуживание и создаст барьеры для кредитных организаций.
В GitHub появилась возможность добавлять в md-файлы динамические диаграммы с помощью генератора Mermaid. До этого диаграммы вставлялись в виде изображений или «рисовались» с помощью символов из ASCII-таблицы. Теперь же полноценную поддержку схем добавили в синтаксис разметки Markdown.
Приветствую, коллеги. Меня зовут Мстислав, я являюсь руководителем Python практики в Usetech. В этой статье я раскрою нюансы работы с PlantUML и C4 моделью. Вся информация является выжимкой из нашего ежедневного опыта. Также необходимо упомянуть, что на эту тему я проводил воркшоп на TechLeadConf 2022, так что при желании, вы всегда можете найти видео.
До появления интернета или начала его широкого применения во всем мире программное обеспечение для разработчиков включало множество печатных руководств и инструкций от производителей, помимо простого комплекта дискет или компакт-дисков и ссылок, где можно скачать нужные руководства. Тогда была эра печатной документации на тысячах страниц, что приводило к очень «тяжёлым» выпускам программного обеспечения. Команда разработчиков документации для Windows решила спросить архивариуса Microsoft Эми Стивенсон о том, какой программный продукт был самым большим.
Российская ассоциация торговых компаний и товаропроизводителей электробытовой и компьютерной техники выпустила заявление. Она напомнила, что новые модели смартфонов, в том числе iPhone 14, «не могут легально обращаться на российском рынке», если не получили сертификаты, декларации, а также специальную нотификацию о характеристиках шифровальных средств и товаров ЕАЭС или заключение Центра по лицензированию, сертификации и защите государственной тайны ФСБ.
Компания Postgres Pro опубликовала перевод на русский язык официальной документации к PostgreSQL 15.0. Вместе с этим компания поделилась общедоступными книгами и учебниками по работе с PostgreSQL.
Ведение документации на свою рабочую сеть давно стало правилом хорошего тона для любого уважающего и считающего себя профессионалом системного администратора. Дело здесь вовсе не в служебных обязанностях, а скорее в прямой необходимости.
Приходя на новое место работы, каждому системному администратору хочется получить пакет исчерпывающей технической документации. И первые по важности в этом пакете документы об устройстве сети и серверов.
Искусство организации рабочего времени (time-management) последнее время обретает всё большую популярность и если раньше это в основном относилось к менеджерам различного уровня, то теперь накопленные знания начинают применяться и в других областях деятельности компании.
Когда перед нашей фрилансерской группой встала задача документирования проекта, были сформулированы следущие требования:
Как известно, программисты, обычно, не очень любят писать документацию… поэтому чем проще и комфортнее будет её писать, тем больше вероятность, что её таки будут писать.
Поскольку мы работаем из дома, то должна быть возможность писать документацию локально, на своей машине.
Чтобы это было делать комфортно, нужна возможность использовать для этого любимый текстовый редактор, никаких форм на вебсайтах а-ля вики или систем заточенных под конкретный редактор/IDE.
С доступом в инет у всех по-разному, и чтобы исключить ситуацию, когда документация небыла написана исключительно потому, что когда появилось настроение её писать по закону подлости отвалился инет — для написания документации не должен требоваться инет.
Документация должна быть доступна всем, кто работает над проектом. Это включает как возможность читать её через вебсайт так и работать с ней как с обычными локальными файлами.
Желательно, чтобы документация поддерживала какой-нить язык разметки и гиперссылки, чтобы её было удобно читать.
Возможность редактировать документацию из браузера (а-ля вики) желательна, но не очень важна (разработчики будут работать с файлами, так что эта фича может пригодиться в основном клиенту, который врядли будет напрямую править документацию).
Сейчас почти в каждой статье про web 2.0 и стартапы среди рекомендаций можно увидеть совет: бросьте долгие раздумья и пред-проектную документацию — делайте проект! И очень часто этот совет воспринимается буквально, первые строчки кода появляются еще до того, как идея окончательно сформируется. Что в итоге? А в итоге ядро системы за весь период разработки переписывается раз по 15, не говоря уже о фронтенде. Как следствие проект который был задуман как 1-2х месячный растягивается на пол-года — год. А код превращается в сборище багов.
Что же сделать что-бы этого избежать и при этом не заниматься планированием по пол-года?
В статье Как создать раздел сайта под управлением «1С Битрикс: Управление сайтом». Основы программирования под Битрикс даётся краткий обзор шагов, необходимых для создания раздела сайта под управлением «1С-Битрикс: Управление сайтом 6.5». Статья может служить отправной точкой для начала изучения принципов программирования под Битрикс. В тексте статьи содержатся ссылки на соответствующие разделы документации и страницы официальных учебных курсов с более детальной информацией.
Дабы избежать нападок в стиле «статья заказная», «автор не разбирается», сразу предупрежу, что статья написана на основе личного опыта авторов по освоению Битрикс-программирования и является конспектом внутреннего семинара компании. Также при создании статьи очень помогли посетители форума офсайта Битрикса, указавшие на неточности.
Обед был омрачен необходимостью разъяснять новому какому-то начальнику-князьку смысл и принципы деятельности некоторых отделов. Высшее начальство, как водится, ни черта не знает о реальных делах своих подчиненных — но хотя бы пожелало разобраться в этот раз. Неприятность состояла в том, что я принципиально за обедом о работе забываю, а тут — надо.
Проект Samba получил спецификации по сетевым протоколам, используемым в серверных вариантах Windows.
Это стало возможным в результате решения Еврокомисии о предоставлении спецификаций протоколов конкурентам. Решение было принято еще в марте 2004, но МС подало аппеляцию, которую суд отклонил в сентябре этого года.
Джереми Аллисон, один из разработчиков Samba, сказал, что соглашение устанавливет точное колечество используемых патентов, так что здесь не может быть двоякого толкования текста в будущем.
считаю что одно из самых правильных способов подачи информации есть графический, т.е. лучше один раз увидеть, чем сто раз услышать.
Никак не комментируя заметку в целом, хотелось бы сделать несколько замечаний по поводу разных способов представления информации в ТЗ и не только в нём.
Я работаю с удивительным человеком. Каждый раз, когда я смотрю в bugzill'у или проверяю почту, я им поражаюсь. Иногда мне кажется, что он мог бы стать неплохим писателем. Во всяком случае графоман из него отличный.
Этот разработчик принимает документирование очень близко к сердцу.
