Size: a a a

DocOps-сообщество

2020 October 26

VS

Vadim Smelyanskiy in DocOps-сообщество
источник

AB

Anatoly Burnashev in DocOps-сообщество
Vadim Smelyanskiy
TypeScript + TSDoc

Сначала казалось, что делаем что-то не то, используя язык программирования для документации, а потом как-то пришло смирение, что богаче и гибче систему типов мы не найдём
[microsoft/tsdoc: A doc comment standard for the TypeScript language](https://github.com/microsoft/tsdoc)

> TSDoc is a proposal to standardize the doc comments used in [TypeScript](http://www.typescriptlang.org/) source files.

Как я понял - этот стандарт хорош для тех, кто пишет на TypeScript?
Остальные продолжают использовать PlantUML ?
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Anatoly Burnashev
[microsoft/tsdoc: A doc comment standard for the TypeScript language](https://github.com/microsoft/tsdoc)

> TSDoc is a proposal to standardize the doc comments used in [TypeScript](http://www.typescriptlang.org/) source files.

Как я понял - этот стандарт хорош для тех, кто пишет на TypeScript?
Остальные продолжают использовать PlantUML ?
TypeScript – в т.ч. про документацию форматов данных.

JSON, это всё ещё JavaScript Object Notation, а в TypeScript'е придумали конструкции для их строгой типизации
источник
2020 October 27

PP

Pavel Peganov in DocOps-сообщество
Не знаю, было ли тут это уже, но мне тут внезапно понадобилось сделать майндмапку, и на глаза попался очень тематичный для канала инструмент:
https://markmap.js.org/repl
Есть в вебе, CLI и VSCode.
источник
2020 November 01

KV

Konstantin Valeev in DocOps-сообщество
Maksim Lapshin
Какие есть годные инструменты для документирования схемы данных.

У меня сейчас два набора:  это одна большая схема из пачки вложенных типов, примерно на 2000 полей и ещё 200 отдельных небольших типов.

Сами типы можно представить в виде JSON schema, можно по-другому если надо.

Для json-schema я нашел адобовский и cloudflare инструменты, оба из которых требуют допила.

Кто чем пользуется?
http://supermodel.io — вот эта штука выглядит очень приятно. Они даже вроде обещают в ближайшем будущем on-premise-решение.
источник
2020 November 03

A

Angela in DocOps-сообщество
кто нить знает какие онлайн линтеры для статических сайтов? сходила сюда, а он завис при проверке

http://doculint.io/
источник

DB

Dima Boger in DocOps-сообщество
А что именно проверять?
источник

DB

Dima Boger in DocOps-сообщество
SEO, быстродействие?
источник

A

Angela in DocOps-сообщество
ссылки хотя бы)
источник

A

Angela in DocOps-сообщество
и это тоже неплохо было бы
источник

DB

Dima Boger in DocOps-сообщество
дисклеймер: я работаю в semrush, и могу быть необъективен

мне нравится семрашевский Site Audit: https://semrush.com/siteaudit/
источник

A

Angela in DocOps-сообщество
Dima Boger
дисклеймер: я работаю в semrush, и могу быть необъективен

мне нравится семрашевский Site Audit: https://semrush.com/siteaudit/
спасибо! попробую
источник

DB

Dima Boger in DocOps-сообщество
он прям много чего проверяет
источник
2020 November 04

NV

Nick Volynkin in DocOps-сообщество
Привет всем, кто сегодня присоединился. Расскажите о себе: чем занимаетесь, что вам интересно про документацию?

(Я временно в отпуске, но тут и без меня есть кому разговор поддержать)
источник

ОИ

Олег Игонин... in DocOps-сообщество
Привет!

Это коллеги из чата аналитиков СПб и Архитекторов IT.

лично у меня часто возникают вопросы по документированию из-за чего свой интерес к этой теме есть.
Также мне важно оставаться информированными и видеть рекомендации и внедрения автоматизированной документации.

Так-то я системный аналитик из Veeam.
источник

ОИ

Олег Игонин... in DocOps-сообщество
В чате аналитиков тема автодокументирования всплывала за короткое время уже два раза.
Видимо системы разрастаются, появляются более сложные требования к структурированию и документированию.
Вот и возникают требования к автоматизации где возможно.

Лично у меня пока заходит только сваггер для описания боевых АПИ. Всё остальное ручками в Confluence и JIRA.
Надеюсь смогу почерпнуть для себя новые варианты.
источник

DG

Dmitry Gurkalov in DocOps-сообщество
Я только спросить, посмотреть зашел.
Вообще Backend разработчик сейчас на Golang, раньше на PHP.
Есть понимание что автоматизированная документация - это хорошо, нужно и правильно. Но по факту ее все равно нужно писать руками (пускай и рядом с кодом) - иной раз хочется вынести все эти аннотации в отдельный структурированный файл и пусть из него конфетка рисуется.
В свое время для пет проекта OpenAPI генерил и искал сервисы/либы, которые по сгенерированной спеке натравят тесты на API (как примеры с example значениями, так и легкий fuzzing). Чтобы была гарантия, что дока высоковероятно отражает работу кода.
Идея - генерить код по спеке все еще в стадии отрицания.
Так что я бы посмотрел канальчик, посмотрел что модно нынче)
источник
2020 November 05

BP

Blaine Philips in DocOps-сообщество
источник

ML

Maksim Lapshin in DocOps-сообщество
Dmitry Gurkalov
Я только спросить, посмотреть зашел.
Вообще Backend разработчик сейчас на Golang, раньше на PHP.
Есть понимание что автоматизированная документация - это хорошо, нужно и правильно. Но по факту ее все равно нужно писать руками (пускай и рядом с кодом) - иной раз хочется вынести все эти аннотации в отдельный структурированный файл и пусть из него конфетка рисуется.
В свое время для пет проекта OpenAPI генерил и искал сервисы/либы, которые по сгенерированной спеке натравят тесты на API (как примеры с example значениями, так и легкий fuzzing). Чтобы была гарантия, что дока высоковероятно отражает работу кода.
Идея - генерить код по спеке все еще в стадии отрицания.
Так что я бы посмотрел канальчик, посмотрел что модно нынче)
> генерить код по спеке все еще в стадии отрицания

зря =) В 2005-м я пилил код на C++, который генерировался из Corba IDL (предтеча протобуфа и gRPC)
источник

DG

Dmitry Gurkalov in DocOps-сообщество
Maksim Lapshin
> генерить код по спеке все еще в стадии отрицания

зря =) В 2005-м я пилил код на C++, который генерировался из Corba IDL (предтеча протобуфа и gRPC)
Сколько лет после этого код проработал в продакшене? Как часто вносились изменения?
источник