Как стать автором
Обновить

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

Время на прочтение 2 мин
Количество просмотров 7.9K
Блог компании ITSumma Разработка веб-сайтов *Open source *Управление персоналом *Подготовка технической документации *

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

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

Читать далее
Всего голосов 29: ↑27 и ↓2 +25
Комментарии 17

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

Время на прочтение 2 мин
Количество просмотров 3.1K
Законодательство в IT IT-компании

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

Читать далее
Всего голосов 14: ↑12 и ↓2 +10
Комментарии 0

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

Время на прочтение 2 мин
Количество просмотров 1.1K
Хранение данных *Законодательство в IT

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

Читать далее
Всего голосов 7: ↑7 и ↓0 +7
Комментарии 0

В GitHub добавили поддержку диаграмм Mermaid

Время на прочтение 1 мин
Количество просмотров 7K
GitHub *Подготовка технической документации *

В GitHub появилась возможность добавлять в md-файлы динамические диаграммы с помощью генератора Mermaid. До этого диаграммы вставлялись в виде изображений или «рисовались» с помощью символов из ASCII-таблицы. Теперь же полноценную поддержку схем добавили в синтаксис разметки Markdown.

Читать далее
Всего голосов 36: ↑35 и ↓1 +34
Комментарии 8

Визуализация архитектуры с помощью C4 модели и PlantUML

Время на прочтение 12 мин
Количество просмотров 5.5K
Блог компании Usetech Анализ и проектирование систем *UML Design *Подготовка технической документации *

Приветствую, коллеги. Меня зовут Мстислав, я являюсь руководителем Python практики в Usetech. В этой статье я раскрою нюансы работы с PlantUML и C4 моделью. Вся информация является выжимкой из нашего ежедневного опыта. Также необходимо упомянуть, что на эту тему я проводил воркшоп на TechLeadConf 2022, так что при желании, вы всегда можете найти видео.

Читать далее
Всего голосов 6: ↑5 и ↓1 +4
Комментарии 4

Комплект компилятора Microsoft C/C++ 7.0 с Windows SDK с документацией весил 18 кг и занимал коробку длиной 60 см

Время на прочтение 1 мин
Количество просмотров 3.4K
Управление разработкой *История IT IT-компании Подготовка технической документации *


До появления интернета или начала его широкого применения во всем мире программное обеспечение для разработчиков включало множество печатных руководств и инструкций от производителей, помимо простого комплекта дискет или компакт-дисков и ссылок, где можно скачать нужные руководства. Тогда была эра печатной документации на тысячах страниц, что приводило к очень «тяжёлым» выпускам программного обеспечения. Команда разработчиков документации для Windows решила спросить архивариуса Microsoft Эми Стивенсон о том, какой программный продукт был самым большим.
Читать дальше →
Всего голосов 9: ↑7 и ↓2 +5
Комментарии 5

РАТЭК: российские продавцы iPhone 14 нарушают закон

Время на прочтение 2 мин
Количество просмотров 2.8K
Законодательство в IT Гаджеты Смартфоны

Российская ассоциация торговых компаний и товаропроизводителей электробытовой и компьютерной техники выпустила заявление. Она напомнила, что новые модели смартфонов, в том числе iPhone 14, «не могут легально обращаться на российском рынке», если не получили сертификаты, декларации, а также специальную нотификацию о характеристиках шифровальных средств и товаров ЕАЭС или заключение Центра по лицензированию, сертификации и защите государственной тайны ФСБ. 

Читать далее
Всего голосов 8: ↑8 и ↓0 +8
Комментарии 6

В свободном доступе опубликована локализованная документация к PostgreSQL 15.0

Время на прочтение 1 мин
Количество просмотров 4.5K
PostgreSQL *Администрирование баз данных *

Компания Postgres Pro опубликовала перевод на русский язык официальной документации к PostgreSQL 15.0. Вместе с этим компания поделилась общедоступными книгами и учебниками по работе с PostgreSQL.

Читать далее
Всего голосов 14: ↑14 и ↓0 +14
Комментарии 4

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

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

Читать дальше →
Всего голосов 16: ↑14 и ↓2 +12
Комментарии 27

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

Время на прочтение 7 мин
Количество просмотров 59K
Системное администрирование *
Приходя на новое место работы, каждому системному администратору хочется получить пакет исчерпывающей технической документации. И первые по важности в этом пакете документы об устройстве сети и серверов.
Читать дальше →
Всего голосов 38: ↑33 и ↓5 +28
Комментарии 13

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

Время на прочтение 11 мин
Количество просмотров 24K
Системное администрирование *
Искусство организации рабочего времени (time-management) последнее время обретает всё большую популярность и если раньше это в основном относилось к менеджерам различного уровня, то теперь накопленные знания начинают применяться и в других областях деятельности компании.
Читать дальше →
Всего голосов 22: ↑17 и ↓5 +12
Комментарии 18

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

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

Читать дальше →
Всего голосов 29: ↑27 и ↓2 +25
Комментарии 22

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

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

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

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

Время на прочтение 2 мин
Количество просмотров 33K
CMS *
Основы программирования под Битрикс

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

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

Читать дальше →
Всего голосов 21: ↑9 и ↓12 -3
Комментарии 15

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

Время на прочтение 1 мин
Количество просмотров 758
Чулан
Обед был омрачен необходимостью разъяснять новому какому-то начальнику-князьку смысл и принципы деятельности некоторых отделов. Высшее начальство, как водится, ни черта не знает о реальных делах своих подчиненных — но хотя бы пожелало разобраться в этот раз. Неприятность состояла в том, что я принципиально за обедом о работе забываю, а тут — надо.
Читать дальше →
Всего голосов 5: ↑5 и ↓0 +5
Комментарии 6

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

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

Читать дальше →
Всего голосов 56: ↑42 и ↓14 +28
Комментарии 81

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

Время на прочтение 1 мин
Количество просмотров 759
Настройка 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
Всего голосов 33: ↑31 и ↓2 +29
Комментарии 41

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

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

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

Читать дальше →
Всего голосов 2: ↑3.5 и ↓-1.5 +5
Комментарии 24

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

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

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