FERRAMENTA PARA DOCUMENTAÇÃO DE CÓDIGO FONTE
Identification
- Clé publique
- radar:r-86f11efcd8d50aa4c33214ced6ee7acf
- Auteurs
- Guilherme Papa de Souza · Luiz Carlos Begosso
- Année déclarée
- 2026
- Langue déclarée
- und
- Type source
- JournalArticle
- Première détection
- 2026-11-13T08:42:09.856273+00:00
- Dernière observation des métadonnées
- 2026-11-13T08:42:09.856273+00:00
- Dernière vérification HTTP
- Non effectuée
Résumé documentaire — langue originale
INTRODUÇÃO A Engenharia de Software cresceu no final da década de 1960, momento marcado pela chamada "crise do software". Esse período foi caracterizado pela ineficiência da indústria em entregar sistemas complexos dentro dos prazos e dos orçamentos previstos, resultando frequentemente em produtos de baixa qualidade e de difícil manutenção. Como resposta a esse cenário, estabeleceu-se a necessidade de aplicar princípios da engenharia ao desenvolvimento do software, colocando a documentação técnica como um de seus pilares fundamentais para garantir a sustentabilidade e a rastreabilidade dos sistemas [4]. Contudo, com a consolidação das metodologias ágeis no início dos anos 2000, o foco da indústria migrou predominantemente para a entrega rápida e a eficiência de processos. Como analisado por Canedo et al. [1], essa mudança frequentemente levou à uma interpretação equivocada dos princípios ágeis, resultando na negligência ou na degradação da documentação em prol da velocidade de codificação. A ausência ou a desatualização das documentações técnicas gera impactos colaterais a longo prazo. Conforme apontam Rosser e Norton [6], essa prática resulta na retenção ou perda do conhecimento, elevando a curva de aprendizado e a integração de novos membros. Além disso, a escassez de registros arquiteturais e de regras de negócio acarreta o aumento do débito técnico, retrabalho frequente, elevação dos custos de manutenção e maior incidência de falhas em ambiente de produção. Diante desse impasse entre a agilidade exigida pelo mercado e a necessidade de registros sustentáveis, faz-se necessário desenvolver estratégias e ferramentas para integrar a documentação diretamente ao fluxo de desenvolvimento contínuo, reduzindo o esforço manual dos desenvolvedores, evitando a perda de conhecimento e minimizando custos operacionais futuros. OBJETIVO O presente trabalho tem por objetivo desenvolver uma ferramenta automatizada para documentação de código-fonte a partir de análise estática, promovendo a integração da documentação ao fluxo de trabalho de desenvolvimento de software. METODOLOGIA Trata -se de uma pesquisa aplicada, de natureza exploratória e experimental, voltada à resolução de um problema prático da Engenharia de Software. O desenvolvimento do trabalho estrutura-se nas seguintes etapas sequenciais: Revisão Sistemática da Literatura: Levantamento e estudo bibliográfico detalhado sobre ferramentas de análise estática de código e padrões de documentação de software consolidados na literatura e na indústria. Definição dos Requisitos e Arquitetura: Identificação e formalização dos requisitos funcionais ( ex : extração de assinaturas de métodos, mapeamento de dependências e geração de diagramas) e não funcionais ( ex : desempenho, usabilidade e portabilidade) da ferramenta. Em seguida, será elaborada a arquitetura técnica do sistema. Desenvolvimento da Ferramenta: A ferramenta foi desenvolvida em Rust , devido à sua alta performance e integração com a biblioteca Tree-Sitter [7], que gera árvores sintáticas ( ASTs ) a partir do código-fonte. Essa árvore é essencial para validar a entrada e extrair elementos como funções, variáveis e classes. Posteriormente, utiliza-se a biblioteca Handlebars [3] para injetar esses dados em um modelo predefinido, gerando o documento final formatado. Por fim, cada arquivo gerado é salvo respeitando a estrutura de diretórios original do projeto, o que facilita a localização e a manipulação manual dos arquivos. Essa estrutura
Identifiants
- DOI
- 10.5281/zenodo.23693546
Repères documentaires
- Famille documentaire
- article
- Types déclarés par les sources
- JournalArticle
- Éditeurs
- Zenodo
Les mentions d’entités ne constituent pas une preuve de reconnaissance juridique. La juridiction étudiée est distincte du pays d’affiliation des auteurs.
Sources
DataCite · Document 1
Citer cette référence
Guilherme Papa de Souza; Luiz Carlos Begosso. FERRAMENTA PARA DOCUMENTAÇÃO DE CÓDIGO FONTE. 2026. https://doi.org/10.5281/zenodo.23693546
JSON · CSL-JSON · BibTeX · RIS · CSV · JSON-LD ·
APA, Chicago, ISO 690 : formats bibliographiques fondés sur les champs disponibles. OSCOLA / Bluebook : données structurées uniquement ; aucune conformité juridique complète n’est revendiquée sans vérification des éléments nécessaires.
- APA
- Guilherme Papa de Souza; Luiz Carlos Begosso. (2026). FERRAMENTA PARA DOCUMENTAÇÃO DE CÓDIGO FONTE. https://doi.org/10.5281/zenodo.23693546
- Chicago
- Guilherme Papa de Souza; Luiz Carlos Begosso. FERRAMENTA PARA DOCUMENTAÇÃO DE CÓDIGO FONTE. 2026. https://doi.org/10.5281/zenodo.23693546
- ISO 690
- Guilherme Papa de Souza; Luiz Carlos Begosso. FERRAMENTA PARA DOCUMENTAÇÃO DE CÓDIGO FONTE. 2026. https://doi.org/10.5281/zenodo.23693546
Warning: Undefined array key "last_link_verified" in /home/clients/e27d81e12f04d2bfd747aa264540ac56/sites/_UDTR_APP/legal_library_reference.php on line 31
UDTR — Bibliothèque juridique mondiale des droits de la Nature. FERRAMENTA PARA DOCUMENTAÇÃO DE CÓDIGO FONTE. Notice documentaire: https://www.declarationuniverselledesdroitsdelarbre.org/global-rights-of-nature-radar/reference/r-86f11efcd8d50aa4c33214ced6ee7acf/ · Dernière vérification HTTP : non effectuée
Données de cette version figée
Dossiers et relations documentaires
Rôles des sources
Source bibliographique / publication d’origine · https://zenodo.org/doi/10.5281/zenodo.23693546
Un lien vers une autorité ne prouve pas à lui seul une affirmation juridique. Les résumés et les textes intégraux restent soumis aux conditions de leur source.
Statut documentaire
Pertinence à examiner
Bibliothèque
Cette identité n’est pas encore intégrée à la Bibliothèque juridique.