Горячее
Лучшее
Свежее
Подписки
Сообщества
Блоги
Эксперты
Войти
Забыли пароль?
или продолжите с
Создать аккаунт
Я хочу получать рассылки с лучшими постами за неделю
или
Восстановление пароля
Восстановление пароля
Получить код в Telegram
Войти с Яндекс ID Войти через VK ID
Создавая аккаунт, я соглашаюсь с правилами Пикабу и даю согласие на обработку персональных данных.
ПромокодыРаботаКурсыРекламаИгрыПополнение Steam
Пикабу Игры +1000 бесплатных онлайн игр
“Рецепт Счастья” — увлекательная игра в жанре «соедини предметы»! Помогите Эмили раскрыть тайны пропавшего родственника, найти сокровища и восстановить её любимое кафе.

Рецепт Счастья

Казуальные, Головоломки, Новеллы

Играть

Топ прошлой недели

  • AlexKud AlexKud 38 постов
  • SergeyKorsun SergeyKorsun 12 постов
  • SupportHuaport SupportHuaport 5 постов
Посмотреть весь топ

Лучшие посты недели

Рассылка Пикабу: отправляем самые рейтинговые материалы за 7 дней 🔥

Нажимая кнопку «Подписаться на рассылку», я соглашаюсь с Правилами Пикабу и даю согласие на обработку персональных данных.

Спасибо, что подписались!
Пожалуйста, проверьте почту 😊

Помощь Кодекс Пикабу Команда Пикабу Моб. приложение
Правила соцсети О рекомендациях О компании
Промокоды Биг Гик Промокоды Lamoda Промокоды МВидео Промокоды Яндекс Директ Промокоды Отелло Промокоды Aroma Butik Промокоды Яндекс Путешествия Постила Футбол сегодня

IT + Техническая документация

С этим тегом используют

Программирование IT юмор Программист Юмор Работа Картинка с текстом Разработка Все
15 постов сначала свежее
989
Skyscrew
Skyscrew
11 месяцев назад
Лига Сисадминов

Хитрость или полезный совет⁠⁠

Хитрость или полезный совет Картинка с текстом, IT, IT юмор, Отладка, Техническая документация
Показать полностью 1
Картинка с текстом IT IT юмор Отладка Техническая документация
46
9
OneMorePikabuer
OneMorePikabuer
1 год назад

Когда проект вырос и надо писать документацию⁠⁠

Когда проект вырос и надо писать документацию
Техническая документация Программирование Разработка IT
0
TheFounder
TheFounder
1 год назад

Как начать писать документацию в VSCode?⁠⁠

Как начать писать документацию в VSCode? Программирование, IT, Программист, Программа, Гайд, Код, Удаленная работа, Техническая документация

Поговаривают, что в некоторых компаниях сотрудники уже не понимают, что происходит в коде проекта. Де-факто для коллективной работы картография проекта — необходимость, нежели привилегия...

Составление пояснений и комментариев к обширным ИИ-системам — трудоемкая задача, но под небольшие опен-сорс/продакшн проекты есть решение.

AutoDocstring — инструмент, который автоматически создает документацию к коду на основе структуры и комментариев. Экономия времени, согласованность стиля, адекватная читаемость и повышенную точность документации — плюсы этого тула. Выделил нужный блок кода, прожал ctrl+shift+2 — готово.

Просматривать строки документации можно во вкладках, выбирать типы форматов строк, выводить типы параметров через подсказки типов pep484, значения и имена переменных. Внутри поддержка args, kwargs, декораторов, ошибок и типов параметров.

Теперь в утилиту можно добавлять "кастомные" документации. Чтобы использовать собственный шаблон, создайте файл .mustache и укажите путь к нему с помощью конфигурации customTemplatePath.

Сгенерированная документация содержит структурированные описания функций, методов и классов. Однако AutoDocstring не всегда правильно интерпретирует комментарии в коде или не учитывает особенности некоторых языков программирования.

А еще записи могут не соответствовать стандартам или требованиям проекта.

Поэтому редактировать и редактировать. Но для создания костяка описаний инструмент — идеально. AutoDocstring сократит время, затрачиваемое на написание документации, на 30-50%. А еще неплохо так снизит число ошибок в тексте.

Скачать можно с официального сайта Microsoft.

Показать полностью 1
Программирование IT Программист Программа Гайд Код Удаленная работа Техническая документация
1
1229
PerfectMilter
PerfectMilter
1 год назад

И не поспоришь⁠⁠

И не поспоришь Программирование, IT, Программист, IT юмор, Техническая документация, Stack overflow
Программирование IT Программист IT юмор Техническая документация Stack overflow
77
0
PNIPU
PNIPU
1 год назад

Долой бумажную волокиту! Ученые ПНИПУ разработали программу для написания технической документации⁠⁠

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

На разработку выдано свидетельство №2024612000.

Для написания технической документации компании чаще всего нанимают отдельных специалистов – технических писателей. Они разрабатывают инструкции по эксплуатации, руководства пользователя, отчеты и другие материалы, которые помогают понять и использовать различные продукты, технологии или услуги. Еще такие люди пишут документы технической спецификации, больше ориентированные на разработчиков или отчетность. Помимо самого написания требуется соблюдать определенные правила и ГОСТы.

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

Ученые Пермского Политеха разработали программу для компьютеров «Техдок менеджер» – это интеллектуальная система помощи техническому писателю. Программа помогает избежать человеческих ошибок (что-то пропустить или перепутать), «интеллектуально» отслеживает даты, термины и прочее. Автоматизирует рутинные процессы и ускоряет документооборот. «Техдок менеджер» может сам следить за выполнением плана работ над проектом без внесения дополнительных данных. «Помощник» легко модифицируется и настраивается под различные задачи и создает множество альтернативных решений.

Логика разработанной программы построена на классификации и кластеризации текстов различной длины, поиске и распознавании сущностей (конкретные объекты или понятия, которые имеют уникальное имя и могут быть идентифицированы в тексте, например, имена людей, названия организаций, даты и т.д.).  «Техдок менеджер» извлекает и систематизирует факты из текста, собирает данные для обработки и понимания естественного языка. Он выявляет содержательные, логические и фактические ошибки, а еще распознает литературные приемы и стили. В итоге синтезирует человеко-читаемый текст на основе выявленной ранее информации и запросов пользователей.

– Ключевая задача нашей программы в том, чтобы одни документы или их части, содержательно зависимые от других, заполнить автоматически. Например, из техзадания органично вытекает технический проект. Его большую часть можно автоматически составить как заготовку документа, но человек должен внести правки. От них уже зависит, например, содержание таких частей как «Введение», «Заключение» и «Список использованных источников». Их можно отредактировать автоматически, – поделился кандидат технических наук, доцент кафедры информационных технологий и автоматизированных систем Даниил Курушин.

Средств автоматизации разработки документации достаточно много, но они чаще всего ориентированы на решение других проблем. Например, современные нейросети способны выполнять рерайтинг и синтез текста, однако результат их работы требует проверки, поскольку они не созданы для работы по стандартам ГОСТ. Разработка ученых ПНИПУ отличается тем, что использует синтез нейронных сетей и специального метода моделирования данных.

– «Помощник техническому писателю» формируется как интерфейс к разрабатываемым нами микропрограммам, скриптам, автоматизирующим работу специалиста. Сначала возникло понимание, что, например, вопросы к курсу лекций можно не сочинять, а написать программу, которая сгенерирует их вместе с вариантами правильных и неправильных ответов. Разумеется, планируется использовать и современные языковые модели, такие как GPT и другие генеративные сети. Также предполагается работа по автоматизированному составлению словарей и справочников, – рассказывает Даниил Курушин.

Программа будет реализована в виде веб-приложения (сайта). Для создания готового текста пользователю необходимо выбрать стандарт, этап и тип документа, который необходимо сформировать, а также написать в окно чата запрос с уточняющими деталями.

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

1/3
Показать полностью 3
IT Python Программирование Техническая документация Документы Бюрократия Длиннопост
0
15
awfun
1 год назад
Лига программистов

Онбординг для программиста⁠⁠

Всем привет, работаю java разработчиком 10 лет, хотел бы рассказать как обычно происходит введение в должность нового сотрудника, aka онбординг.

Вы получили пропуск, технику, пароль от учетки, познакомились с командой проекта. Один из команды становится ответственным за то чтобы направить вас на начальных этапах, он называется buddy.

В идеальном случае есть документация для нового сотрудника - как получать доступы, как деплоить и смотреть логи и прочие необходимые вещи. Скоре всего инструкции или будут отсутствовать (в маленькой компании) или будут не полностью актуальны (в большой).

Нужно чтобы вас добавили в общие чаты, общие емейлы и встречи команды. Тут же могут подсказать чат с мемами, чат обеда и прочие места интересов.

Требуется ознакомиться также с административными системами - таск трекер, учет времени, hr системы.

Дальше вам должны дать задачу по разработке, в идеальном случае это должен быть очевидный фикс, который позволит отработать внесение изменений, согласование пулл реквеста, деплой на тестовый стенд, передачу в тестирование и прочие шаги.

Далее сложность задач будет идти по нарастающей, и buddy будет участвовать всё меньше.

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

Отдельно выделю важность документации по предоставлению доступов. После увольнения сотрудника желательно "прибрать" за ним, пройдя по списку доступов и деактивировав их.

Всем удачных трудоустройств!

Показать полностью
[моё] IT Программирование Разработка Работа Техническая документация Проект Программист Текст
15
24
cherkalexander
cherkalexander
2 года назад
Лига программистов

Excalidraw — сервис для рисования диаграмм⁠⁠

На днях узнал о классном сервисе для рисования диаграмм:

  • В бесплатной версии можно работать лишь на одном холсте, но его можно сохранить локально и таким образом работать над несколькими диаграммами

  • Доступные разные стили оформления текста, мне очень нравится рукописный

  • Можно использовать сторонние библиотеки компонентов, например, чтобы рисовать UML диаграммы

Excalidraw — сервис для рисования диаграмм IT, Tools, Инструменты, Техническая документация, Диаграмма

https://t.me/cherkashindev/84

Показать полностью 1
[моё] IT Tools Инструменты Техническая документация Диаграмма
9
4631
Pika.chu.bu
Pika.chu.bu
2 года назад
IT-юмор

Я и есть документация⁠⁠

Я и есть документация Картинка с текстом, Юмор, IT, Техническая документация, IT юмор, Breaking Bad

Джун - Где документация?

Тимлид - Я и есть документация

Картинка с текстом Юмор IT Техническая документация IT юмор Breaking Bad
123
Посты не найдены
О нас
О Пикабу Контакты Реклама Сообщить об ошибке Сообщить о нарушении законодательства Отзывы и предложения Новости Пикабу Мобильное приложение RSS
Информация
Помощь Кодекс Пикабу Команда Пикабу Конфиденциальность Правила соцсети О рекомендациях О компании
Наши проекты
Блоги Работа Промокоды Игры Курсы
Партнёры
Промокоды Биг Гик Промокоды Lamoda Промокоды Мвидео Промокоды Яндекс Директ Промокоды Отелло Промокоды Aroma Butik Промокоды Яндекс Путешествия Постила Футбол сегодня
На информационном ресурсе Pikabu.ru применяются рекомендательные технологии