Телеграмм чат группы technicalwriters страница 2837

а есть пример как это в итоге собирается?

На сайте codeflow введение в явадок посмотрите

19:08пожаловаться #1

a

arvikon in technicalwriters

Milkhail Che

А есть ли инструменты автоматизирующие снятие/актуализацию скриншотов?

Например, пишешь скрипт: иди по такой ссылке, возьми такую-то область экрана, сохрани туда-то с таким названием.

puppeteer умеет

19:22пожаловаться #2

OY

Это если код изначально комментировали?

19:23пожаловаться #3

OY

А если нет?

Taking screenshots with OpenCV and Python - PyImageSearch

19:23пожаловаться #4

SR

Stas Rychkov in technicalwriters

Milkhail Che

А есть ли инструменты автоматизирующие снятие/актуализацию скриншотов?

Например, пишешь скрипт: иди по такой ссылке, возьми такую-то область экрана, сохрани туда-то с таким названием.

OpenCV можно использовать. https://www.pyimagesearch.com/2018/01/01/taking-screenshots-with-opencv-and-python/

PyImageSearch

This guide will teach you how to take screenshots/screen captures using OpenCV and Python.

19:25пожаловаться #5

NV

коллеги, кто из техписателей документирует код, поделитесь опытом и примерами, пожалуйста

А расскажите конкретнее, что вы хотите документировать и как?
— автогенерируемая референсная документация к библиотеке или REST API
— документация для обучения работе с кодом (tutorials, how-to)
— архитектурная документация про внутреннее устройство программы

Ну и на каком языке код?

19:27пожаловаться #6

SR

Stas Rychkov in technicalwriters

Activity: Generate a Javadoc from a sample project

а есть пример как это в итоге собирается?

Есть. Но, как Николай сказал, есть нюансы. https://idratherbewriting.com/learnapidoc/nativelibraryapis_create_javadoc.html

Documenting APIs

Javadoc is the standard output for Java APIs, and it’s somewhat effortless to build a Javadoc. The Javadoc is generated through something called a “doclet.” Different doclets can parse the Java annotations in different ways and produce different outputs. But by and large, almost every Java documentation uses the standard doclet. The Javadoc output will be familiar and welcome to Java developers.

19:32пожаловаться #7

NV

а есть пример как это в итоге собирается?

Вся документация к стандартной библиотеке Java собирается именно javadoc'ом. В последний раз, когда смотрел, выглядела она так себе ))

19:32пожаловаться #8

OY

Nick Volynkin

А расскажите конкретнее, что вы хотите документировать и как?
— автогенерируемая референсная документация к библиотеке или REST API
— документация для обучения работе с кодом (tutorials, how-to)
— архитектурная документация про внутреннее устройство программы

Ну и на каком языке код?

Думаю как выполнить требование :
Программный код должен быть читаем и хорошо задокументирован с помощью комментариев, окружение и зависимости подробно описаны

19:48пожаловаться #9

NV

Думаю как выполнить требование :
Программный код должен быть читаем и хорошо задокументирован с помощью комментариев, окружение и зависимости подробно описаны

Можно написать кучу комментариев, но код будет плохо задокументирован. :)

Зависимости описываются в машиночитаемом формате, словами о них не нужно писать. В случае Java это скорее всего будет конфигурация maven. (Кстати, а почему мы именно про Java говорим?).

19:57пожаловаться #10

OY

Nick Volynkin

Можно написать кучу комментариев, но код будет плохо задокументирован. :)

Зависимости описываются в машиночитаемом формате, словами о них не нужно писать. В случае Java это скорее всего будет конфигурация maven. (Кстати, а почему мы именно про Java говорим?).

И это делает тех.писатель?

19:59пожаловаться #11

NV

Зависимости — нет, только разработчики. Комментарии в коде — по-разному бывает.

20:02пожаловаться #12

NV

Думаю как выполнить требование :
Программный код должен быть читаем и хорошо задокументирован с помощью комментариев, окружение и зависимости подробно описаны

А читаемость кода — это тоже задача разработчиков.

20:03пожаловаться #13

вд

всем добра in technicalwriters

И это делает тех.писатель?

Ну какой-нибудь уровня senior почему бы и нет. Особенно за неплохую прибавку к окладу. Да и быть ближе к разработке как-то лучше что ли. У них и гит, и atom,и intellijidea с корпоративной лицензией...

20:03пожаловаться #14

вд

всем добра in technicalwriters

Nick Volynkin

А читаемость кода — это тоже задача разработчиков.

Прямая, я бы добавил

20:04пожаловаться #15

NV