Ответы пользователя по тегу Документация
  • Какие существуют средства автодокументации кода Python для недокументированного кода?

    2ord
    @2ord Автор вопроса
    В итоге я написал своей инструмент для автодокументации.
    Как это работает:
    Код парсится в AST при помощи модуля ast. Ходим по узлам я проверяем не является ли функцией, проверяя, нет ли существующей документации функции ast.get_docstring(node).
    Если отсутствует, то получаем тело функции ast.unparse(node) и отправляем запрос LLM с промптом (использовал Codestral), прося подготовить краткое описание назначения функции согласно PEP 257. Полученный ответ вставляется обратно в тело функции в ее узле.

    Из минусов следует отметить, что модуль "ast" отбрасывает комментарии в коде при его парсинге, что потенциально могло добавить некоторые нюансы при генерации docstring.

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

    В качестве оптимизации, чтобы сберечь запросы при дебагинге, воспользовался хранилищем K/V.
    Ответ написан
    Комментировать
  • Как делать поиск по содержимому файлов(документов) на Android'е?

    2ord
    @2ord
    Из мобильных устройств обычно не делают файлопомойки и ещё они ломаются и пропадают.
    По той же причине чаще всего предлагаются облачные сервисы где и хранятся данные (как бы в большей безопасности).

    Но если сильно надо, то бери в руки Apache Tika, извлекай метаданные файлов, индексируй в локальной базе или в облако. Затем построй UI интерфейс к хранилищу.
    Ответ написан
  • Какие средства есть индексации документации docx\pdf?

    2ord
    @2ord
    DocFetcher, например
    Ответ написан
    Комментировать
  • Как правильно вести техническую документацию Системному администратору?

    2ord
    @2ord
    Легко начать с ДокуВики. Эта Вики проста в установке (1 пакет в Линуксе) и использовании и неоднократно помогала мне в работе. Не нужны никакие папки с кучей документов, а есть информационная система с поиском, База Знаний.
    Легко пополнять постепенно, не заостряя внимание на конкретном документе.
    Ответ написан
    1 комментарий
  • В чем лучше составлять тех документацию для работающего проекта?

    2ord
    @2ord
    У нас в команде используется DokuWiki. Есть поиск по документации, история прежних правок и т.д. Удобнее чем Word.
    Установка в Ubuntu/Debian Linux проста, через штатный менеджер.
    Касаемо документации стоит составить карту различных частей проекта и выставить ссылки на них в иерархии. Можно прикрепить изображения различных диаграмм, ссылки на внешние ресурсы и т.д. Также удобно ссылаться на какие-то внутренние системы, допустим JIRA: [[jira>issue-12345]]
    В DokuWiki используются пространства:имён для ведения иерархии.
    Ответ написан
    Комментировать
  • Где найти документацию по SDL2?

    2ord
    @2ord
    Ответ написан
    Комментировать