Skip to main content

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

Project description

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

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

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
  1. Publique no TestPyPI (recomendado primeiro):
python -m twine upload --repository testpypi dist/*
  1. 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: rpa.tiop@broadcast.com.br.
  • O ponto focal de negocio e preenchido pelo campo focal_point.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docaut_padronizado-0.1.0.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docaut_padronizado-0.1.0-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file docaut_padronizado-0.1.0.tar.gz.

File metadata

  • Download URL: docaut_padronizado-0.1.0.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.9

File hashes

Hashes for docaut_padronizado-0.1.0.tar.gz
Algorithm Hash digest
SHA256 aa5963db04061799dbb3e4d351af0dd60f596726c494beb0b4df6b209f967c44
MD5 e643dcdb65475854bee5eade2dcf8bd6
BLAKE2b-256 e1017a3b3b116c9d3bb4ef8435e7b478a9c3c4a9b4f32d583d057f8d21e7d4c5

See more details on using hashes here.

File details

Details for the file docaut_padronizado-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for docaut_padronizado-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ef619257d375d81057c5c6cf3f69da94ac435c53732f5112542a8b72472fdf5
MD5 d876d04732dbe55033b37fc59c91f7b8
BLAKE2b-256 7aab44f6eea30b1235b172e71e9eae612fa2a0a7efa6447bbc25d4523403d3d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page