SlideShare a Scribd company logo
1 of 10
Download to read offline
COMMENT LINT
ПОЧЕМУ ВАШЕМУ БИЗНЕСУ НУЖЕН
ИССЛЕДОВАНИЕ УЧЕТА ВРЕМЕНИ РАБОТЫ ПРОГРАММИСТОВ
СКОЛЬКО ВРЕМЕНИ ПРОГРАММИСТ ТРАТИТ НА НАПИСАНИЕ ДОКУМЕНТАЦИИ
▸ Программисты редко читают внутреннюю документацию проекта, тяжело
воспринимают старый код (читай: легаси), но уделяют пристальное
внимание на комментарии в коде.


▸ Понятные комментарии в кодовой базе это простой способ повысить
качество внутренней документации проекта. Удобная документация
высвобождает труд программистов для


кодирования и отладки. 10 %
25 %
45 %
20 %
Кодирование
Отладка
Планирование
Документация
АНАЛИЗ ПРЕДЛОЖЕННОГО РЕШЕНИЯ
COMMENT LINT ПРОВЕРЯЕТ КАЧЕСТВО ЧИТАЕМОСТИ РУССКОЙ ДОКУМЕНТАЦИИ
▸ Написать хороший комментарий для программиста сложно: нужно
отлично понимать предметную область, кодовую базу проекта и внятно
излагать свои мысли.


▸ Наше решение автоматически проверяет комментарии, подсвечивает
сложные для восприятия речевые формы. Подсказывает как улучшить
читаемость текста, выделяет фразы паразиты, нецензурную лексику,
неполиткорректные термины.


▸ Комментарии исправленные через Comment Lint сделают вашу
документацию легкой для понимания и инклюзивно корректной.
ПРИМЕРЫ ПЛОХИХ КОММЕНТАРИЕВ И ИХ ПРОВЕРКА С ПОМОЩЬЮ ДВИЖКА COMMENT LINT
КОММЕНТАРИИ ДОЛЖНЫ ОБЪЯСНЯТЬ НАМЕРЕНИЯ ПРОГРАММИСТА
ПРИМЕР РАБОТЫ COMMENT LINT
ДЕМОНСТРАЦИЯ ВОЗМОЖНОСТЕЙ ПЛАГИНА
МЫ ОРИЕНТИРУЕМСЯ НА БОЛЬШИЕ КОМПАНИИ И КОМПАНИИ С ВЫСОКОЙ ТЕКУЧКОЙ КАДРОВ
ЦЕНА РЕШЕНИЯ
Демо режим
Для небольших
компаний
Для больших
компаний
Для внедрения в
инфраструктуру
компании
API:


1 запрос в минуту
API:


До 30к запросов в
месяц
API:


До 200к запросов в
месяц
Самостоятельная
установка (Docker)
Бесплатно 130 тысяч рублей в год
250 тысяч рублей в
год
Цена по запросу
ДОРОЖНАЯ КАРТА COMMENT LINT
РЕШЕНИЕ ПО СОКРАЩЕНИЮ ВРЕМЕНИ НА НАПИСАНИЕ ДОКУМЕНТАЦИИ
▸ Плагин уже работает на популярных продуктах от JetBrains:


IntelliJ IDEA 2021+


WebStorm


PhpStorm


▸ Планируется поддержка:


Microsoft Visual Studio Code


Sublime Text


▸ Поддержка MarkDown документации
АВТОРЫ ИДЕИ
МЫ СПЛОЧЕННАЯ КОМАНДА ПРОФЕССИОНАЛОВ
Денис Басковский


Front End


(MTC Ticketland)
Егор Сафонов


Java


(СПбМТСБ)
Анатолий Буров


Python


(GLVRD)
ПОДКЛЮЧАЙТЕСЬ!
Отправить заявку
ИСПОЛЬЗУЕМЫЕ РЕСУРСЫ
ПОЛЕЗНЫЕ ССЫЛКИ
▸ Персональный блог ИТ-консультанта Басковского Дениса


https://baskovsky.ru/


▸ Официальный сайт glvrd


https://glvrd.ru/api/


▸ Репозиторий проекта


https://github.com/qertis/comment-lint

More Related Content

What's hot

Гибкие методики разработки. Кто их придумал и почему
Гибкие методики разработки. Кто их придумал и почемуГибкие методики разработки. Кто их придумал и почему
Гибкие методики разработки. Кто их придумал и почемуDmitry Savchenko
 
Why you should build mockups (SD2)
Why you should build mockups (SD2)Why you should build mockups (SD2)
Why you should build mockups (SD2)Alexander Virkovski
 
Интегрированная среда разработки
Интегрированная среда разработкиИнтегрированная среда разработки
Интегрированная среда разработкиspillector
 
Практика работы с крупными проектами - от Scrum с XP к Kanban
Практика работы с крупными проектами - от Scrum с XP к KanbanПрактика работы с крупными проектами - от Scrum с XP к Kanban
Практика работы с крупными проектами - от Scrum с XP к KanbanAlexander Byndyu
 

What's hot (6)

Гибкие методики разработки. Кто их придумал и почему
Гибкие методики разработки. Кто их придумал и почемуГибкие методики разработки. Кто их придумал и почему
Гибкие методики разработки. Кто их придумал и почему
 
Tdd from the middle
Tdd from the middleTdd from the middle
Tdd from the middle
 
Why you should build mockups (SD2)
Why you should build mockups (SD2)Why you should build mockups (SD2)
Why you should build mockups (SD2)
 
Why you should build mockups
Why you should build mockupsWhy you should build mockups
Why you should build mockups
 
Интегрированная среда разработки
Интегрированная среда разработкиИнтегрированная среда разработки
Интегрированная среда разработки
 
Практика работы с крупными проектами - от Scrum с XP к Kanban
Практика работы с крупными проектами - от Scrum с XP к KanbanПрактика работы с крупными проектами - от Scrum с XP к Kanban
Практика работы с крупными проектами - от Scrum с XP к Kanban
 

Similar to Comment Lint

Разработка в долг
Разработка в долгРазработка в долг
Разработка в долгVitebsk Miniq
 
Олег Бунин, 20 рисков, которые необходимо учесть при расчёте сложного проекта
Олег Бунин, 20 рисков, которые необходимо учесть при расчёте сложного проектаОлег Бунин, 20 рисков, которые необходимо учесть при расчёте сложного проекта
Олег Бунин, 20 рисков, которые необходимо учесть при расчёте сложного проектаScrumTrek
 
Виталий Шибаев - Креативный менеджмент глазами разработчика: как выжить в agi...
Виталий Шибаев - Креативный менеджмент глазами разработчика: как выжить в agi...Виталий Шибаев - Креативный менеджмент глазами разработчика: как выжить в agi...
Виталий Шибаев - Креативный менеджмент глазами разработчика: как выжить в agi...HappyDev
 
Профессии в IT
Профессии в ITПрофессии в IT
Профессии в IT0leGG
 
Content is King. В какие процессы интернет-магазина вовлечена контент-команда?
Content is King. В какие процессы интернет-магазина вовлечена контент-команда?Content is King. В какие процессы интернет-магазина вовлечена контент-команда?
Content is King. В какие процессы интернет-магазина вовлечена контент-команда?Anton Grishin
 
Риски, которые необходимо учесть при разработке сложного проекта (Олег Бунин)
Риски, которые необходимо учесть при разработке сложного проекта (Олег Бунин)Риски, которые необходимо учесть при разработке сложного проекта (Олег Бунин)
Риски, которые необходимо учесть при разработке сложного проекта (Олег Бунин)Ontico
 
Сделать в срок: сайт за две недели
Сделать в срок: сайт за две неделиСделать в срок: сайт за две недели
Сделать в срок: сайт за две неделиsportgid
 
Проектирование Программных Систем. Лекция 01
Проектирование Программных Систем. Лекция 01Проектирование Программных Систем. Лекция 01
Проектирование Программных Систем. Лекция 01Dima Dzuba
 
Методики управления развитием ис на базе 1с
Методики управления развитием ис на базе 1сМетодики управления развитием ис на базе 1с
Методики управления развитием ис на базе 1сHelen Kopteva
 
Tech Talks @NSU: Рассказ о разных профессиях в IT-индустрии, или почему не вс...
Tech Talks @NSU: Рассказ о разных профессиях в IT-индустрии, или почему не вс...Tech Talks @NSU: Рассказ о разных профессиях в IT-индустрии, или почему не вс...
Tech Talks @NSU: Рассказ о разных профессиях в IT-индустрии, или почему не вс...Tech Talks @NSU
 
Сергі Поволяшко "Замовник Вас використовує. Що робити?"
Сергі Поволяшко "Замовник Вас використовує. Що робити?"Сергі Поволяшко "Замовник Вас використовує. Що робити?"
Сергі Поволяшко "Замовник Вас використовує. Що робити?"Lviv Startup Club
 
Повышаем и следим за качеством PHP кода
Повышаем и следим за качеством PHP кодаПовышаем и следим за качеством PHP кода
Повышаем и следим за качеством PHP кодаAleksandr Makhomet
 
AgileBaseCamp 2013 - Start Up and Get Done
AgileBaseCamp 2013 - Start Up and Get DoneAgileBaseCamp 2013 - Start Up and Get Done
AgileBaseCamp 2013 - Start Up and Get DoneMax Klymyshyn
 
Разработка через ADD
Разработка через ADDРазработка через ADD
Разработка через ADDSergey Staroletov
 
Наблюдай. Анализируй. Управляй
Наблюдай. Анализируй. УправляйНаблюдай. Анализируй. Управляй
Наблюдай. Анализируй. УправляйMax Babich
 
Стройные процессы = эффективный интерфейс. Лидия Богданович
Стройные процессы = эффективный интерфейс. Лидия Богданович Стройные процессы = эффективный интерфейс. Лидия Богданович
Стройные процессы = эффективный интерфейс. Лидия Богданович ПрофсоUX
 
Code review как средство обеспечения качества программного обеспечения
Code review как средство обеспечения качества программного обеспеченияCode review как средство обеспечения качества программного обеспечения
Code review как средство обеспечения качества программного обеспеченияSQALab
 
Разработка нового сайта компании «Росгосстрах»
Разработка нового сайта компании «Росгосстрах»Разработка нового сайта компании «Росгосстрах»
Разработка нового сайта компании «Росгосстрах»РОСГОССТРАХ
 
Разработка веб-сервисов осень 2013 лекция 3
Разработка веб-сервисов осень 2013 лекция 3Разработка веб-сервисов осень 2013 лекция 3
Разработка веб-сервисов осень 2013 лекция 3Technopark
 

Similar to Comment Lint (20)

Разработка в долг
Разработка в долгРазработка в долг
Разработка в долг
 
Олег Бунин, 20 рисков, которые необходимо учесть при расчёте сложного проекта
Олег Бунин, 20 рисков, которые необходимо учесть при расчёте сложного проектаОлег Бунин, 20 рисков, которые необходимо учесть при расчёте сложного проекта
Олег Бунин, 20 рисков, которые необходимо учесть при расчёте сложного проекта
 
Виталий Шибаев - Креативный менеджмент глазами разработчика: как выжить в agi...
Виталий Шибаев - Креативный менеджмент глазами разработчика: как выжить в agi...Виталий Шибаев - Креативный менеджмент глазами разработчика: как выжить в agi...
Виталий Шибаев - Креативный менеджмент глазами разработчика: как выжить в agi...
 
Профессии в IT
Профессии в ITПрофессии в IT
Профессии в IT
 
Content is King. В какие процессы интернет-магазина вовлечена контент-команда?
Content is King. В какие процессы интернет-магазина вовлечена контент-команда?Content is King. В какие процессы интернет-магазина вовлечена контент-команда?
Content is King. В какие процессы интернет-магазина вовлечена контент-команда?
 
Риски, которые необходимо учесть при разработке сложного проекта (Олег Бунин)
Риски, которые необходимо учесть при разработке сложного проекта (Олег Бунин)Риски, которые необходимо учесть при разработке сложного проекта (Олег Бунин)
Риски, которые необходимо учесть при разработке сложного проекта (Олег Бунин)
 
Сделать в срок: сайт за две недели
Сделать в срок: сайт за две неделиСделать в срок: сайт за две недели
Сделать в срок: сайт за две недели
 
Проектирование Программных Систем. Лекция 01
Проектирование Программных Систем. Лекция 01Проектирование Программных Систем. Лекция 01
Проектирование Программных Систем. Лекция 01
 
Методики управления развитием ис на базе 1с
Методики управления развитием ис на базе 1сМетодики управления развитием ис на базе 1с
Методики управления развитием ис на базе 1с
 
Tech Talks @NSU: Рассказ о разных профессиях в IT-индустрии, или почему не вс...
Tech Talks @NSU: Рассказ о разных профессиях в IT-индустрии, или почему не вс...Tech Talks @NSU: Рассказ о разных профессиях в IT-индустрии, или почему не вс...
Tech Talks @NSU: Рассказ о разных профессиях в IT-индустрии, или почему не вс...
 
Сергі Поволяшко "Замовник Вас використовує. Що робити?"
Сергі Поволяшко "Замовник Вас використовує. Що робити?"Сергі Поволяшко "Замовник Вас використовує. Що робити?"
Сергі Поволяшко "Замовник Вас використовує. Що робити?"
 
Повышаем и следим за качеством PHP кода
Повышаем и следим за качеством PHP кодаПовышаем и следим за качеством PHP кода
Повышаем и следим за качеством PHP кода
 
AgileBaseCamp 2013 - Start Up and Get Done
AgileBaseCamp 2013 - Start Up and Get DoneAgileBaseCamp 2013 - Start Up and Get Done
AgileBaseCamp 2013 - Start Up and Get Done
 
Разработка через ADD
Разработка через ADDРазработка через ADD
Разработка через ADD
 
Наблюдай. Анализируй. Управляй
Наблюдай. Анализируй. УправляйНаблюдай. Анализируй. Управляй
Наблюдай. Анализируй. Управляй
 
Стройные процессы = эффективный интерфейс. Лидия Богданович
Стройные процессы = эффективный интерфейс. Лидия Богданович Стройные процессы = эффективный интерфейс. Лидия Богданович
Стройные процессы = эффективный интерфейс. Лидия Богданович
 
Code review как средство обеспечения качества программного обеспечения
Code review как средство обеспечения качества программного обеспеченияCode review как средство обеспечения качества программного обеспечения
Code review как средство обеспечения качества программного обеспечения
 
Petr petrov prezentatsiia
Petr petrov prezentatsiiaPetr petrov prezentatsiia
Petr petrov prezentatsiia
 
Разработка нового сайта компании «Росгосстрах»
Разработка нового сайта компании «Росгосстрах»Разработка нового сайта компании «Росгосстрах»
Разработка нового сайта компании «Росгосстрах»
 
Разработка веб-сервисов осень 2013 лекция 3
Разработка веб-сервисов осень 2013 лекция 3Разработка веб-сервисов осень 2013 лекция 3
Разработка веб-сервисов осень 2013 лекция 3
 

More from Денис Сергеевич Басковский (10)

Стратегия децентрализованной автономной организации
Стратегия децентрализованной автономной организацииСтратегия децентрализованной автономной организации
Стратегия децентрализованной автономной организации
 
MTC Karma
MTC KarmaMTC Karma
MTC Karma
 
ВидеоКонс
ВидеоКонсВидеоКонс
ВидеоКонс
 
HR от Басковского
HR от БасковскогоHR от Басковского
HR от Басковского
 
ProstoDiary presentation
ProstoDiary presentationProstoDiary presentation
ProstoDiary presentation
 
Trader Pet
Trader PetTrader Pet
Trader Pet
 
Trip Adventurer
Trip Adventurer Trip Adventurer
Trip Adventurer
 
Qweeto Social Travel
Qweeto Social TravelQweeto Social Travel
Qweeto Social Travel
 
Ускорение фронтенда ponominalu.ru
Ускорение фронтенда ponominalu.ruУскорение фронтенда ponominalu.ru
Ускорение фронтенда ponominalu.ru
 
Введение в CodeQL
Введение в CodeQLВведение в CodeQL
Введение в CodeQL
 

Comment Lint

  • 1. COMMENT LINT ПОЧЕМУ ВАШЕМУ БИЗНЕСУ НУЖЕН
  • 2. ИССЛЕДОВАНИЕ УЧЕТА ВРЕМЕНИ РАБОТЫ ПРОГРАММИСТОВ СКОЛЬКО ВРЕМЕНИ ПРОГРАММИСТ ТРАТИТ НА НАПИСАНИЕ ДОКУМЕНТАЦИИ ▸ Программисты редко читают внутреннюю документацию проекта, тяжело воспринимают старый код (читай: легаси), но уделяют пристальное внимание на комментарии в коде. ▸ Понятные комментарии в кодовой базе это простой способ повысить качество внутренней документации проекта. Удобная документация высвобождает труд программистов для 
 кодирования и отладки. 10 % 25 % 45 % 20 % Кодирование Отладка Планирование Документация
  • 3. АНАЛИЗ ПРЕДЛОЖЕННОГО РЕШЕНИЯ COMMENT LINT ПРОВЕРЯЕТ КАЧЕСТВО ЧИТАЕМОСТИ РУССКОЙ ДОКУМЕНТАЦИИ ▸ Написать хороший комментарий для программиста сложно: нужно отлично понимать предметную область, кодовую базу проекта и внятно излагать свои мысли. ▸ Наше решение автоматически проверяет комментарии, подсвечивает сложные для восприятия речевые формы. Подсказывает как улучшить читаемость текста, выделяет фразы паразиты, нецензурную лексику, неполиткорректные термины. ▸ Комментарии исправленные через Comment Lint сделают вашу документацию легкой для понимания и инклюзивно корректной.
  • 4. ПРИМЕРЫ ПЛОХИХ КОММЕНТАРИЕВ И ИХ ПРОВЕРКА С ПОМОЩЬЮ ДВИЖКА COMMENT LINT КОММЕНТАРИИ ДОЛЖНЫ ОБЪЯСНЯТЬ НАМЕРЕНИЯ ПРОГРАММИСТА
  • 5. ПРИМЕР РАБОТЫ COMMENT LINT ДЕМОНСТРАЦИЯ ВОЗМОЖНОСТЕЙ ПЛАГИНА
  • 6. МЫ ОРИЕНТИРУЕМСЯ НА БОЛЬШИЕ КОМПАНИИ И КОМПАНИИ С ВЫСОКОЙ ТЕКУЧКОЙ КАДРОВ ЦЕНА РЕШЕНИЯ Демо режим Для небольших компаний Для больших компаний Для внедрения в инфраструктуру компании API: 
 1 запрос в минуту API: 
 До 30к запросов в месяц API: До 200к запросов в месяц Самостоятельная установка (Docker) Бесплатно 130 тысяч рублей в год 250 тысяч рублей в год Цена по запросу
  • 7. ДОРОЖНАЯ КАРТА COMMENT LINT РЕШЕНИЕ ПО СОКРАЩЕНИЮ ВРЕМЕНИ НА НАПИСАНИЕ ДОКУМЕНТАЦИИ ▸ Плагин уже работает на популярных продуктах от JetBrains: 
 IntelliJ IDEA 2021+ 
 WebStorm 
 PhpStorm ▸ Планируется поддержка: 
 Microsoft Visual Studio Code 
 Sublime Text ▸ Поддержка MarkDown документации
  • 8. АВТОРЫ ИДЕИ МЫ СПЛОЧЕННАЯ КОМАНДА ПРОФЕССИОНАЛОВ Денис Басковский Front End (MTC Ticketland) Егор Сафонов Java (СПбМТСБ) Анатолий Буров Python (GLVRD)
  • 10. ИСПОЛЬЗУЕМЫЕ РЕСУРСЫ ПОЛЕЗНЫЕ ССЫЛКИ ▸ Персональный блог ИТ-консультанта Басковского Дениса 
 https://baskovsky.ru/ ▸ Официальный сайт glvrd 
 https://glvrd.ru/api/ ▸ Репозиторий проекта 
 https://github.com/qertis/comment-lint