DocAut-Padronizado 0.1.3

Gerador de documentacao tecnica e manual de servico em DOCX para robos de automacao.

DocAut_Padronizado

HomePage: https://pypi.org/manage/project/DocAut_Padronizado/releases/

Repositorio: https://github.com/kpersich0054/Biblioteca_Documenta-o_AE

Biblioteca PyPI para gerar automaticamente:

• {robo}_documentacao_tecnica.docx
• {robo}_manual_servico.docx

com base no padrao definido em padrao_documentacao.md.

Recursos

• Gera Documentacao Tecnica com secoes obrigatorias.
• Gera Manual de Servico com linguagem orientada ao negocio.
• Aplica estilo visual padrao (titulos azuis, tabelas com cabecalho azul e linhas alternadas).
• Suporta primeira versao e atualizacao.
• Em atualizacao, extrai historico de alteracoes dos DOCX existentes e adiciona nova entrada.

Instalacao local

pip install -e .

CLI

Depois da instalacao, o comando disponivel e:

rpa-docs

Se o comando rpa-docs nao estiver no PATH do Windows, use a forma abaixo, que nao depende da pasta Scripts:

py -m rpa_documentacao wizard --output-dir ./saida

1. Primeira versao com JSON

rpa-docs generate --input example_project_data.json --output-dir ./saida

2. Atualizacao de versao

rpa-docs update \
  --input example_project_data.json \
  --output-dir ./saida \
  --existing-tech "C:/docs/meu_robo_documentacao_tecnica.docx" \
  --existing-service "C:/docs/meu_robo_manual_servico.docx" \
  --updated-by "Maria Souza" \
  --change-description "Ajuste de regras de validacao"

3. Modo interativo

rpa-docs wizard --output-dir ./saida

Ou, sem depender do PATH:

py -m rpa_documentacao wizard --output-dir ./saida

Estrutura esperada de JSON

Use o arquivo example_project_data.json como base.

Campos principais:

• robot_name
• developer_name
• machine_name
• code_path
• technical_objective
• service_delivery
• business_problem
• tabelas em formato lista de objetos (ex: credentials_rows, indicators_rows)

Publicacao no PyPI

1. Atualize a versao no pyproject.toml.
2. Gere os pacotes:

python -m pip install --upgrade build twine
python -m build

3. Publique no TestPyPI (recomendado primeiro):

python -m twine upload --repository testpypi dist/*

4. Publique no PyPI oficial:

python -m twine upload dist/*

Observacoes

• O manual nao inclui secao de "Proximos Passos".
• O e-mail de suporte da automacao e sempre incluido: [e-mail].
• O ponto focal de negocio e preenchido pelo campo focal_point.