• Revista PROGRAMAR: Já está disponível a edição #53 da revista programar. Faz já o download aqui!

magician

Criar documentação

9 mensagens neste tópico

Boas gostaria de saber como fazem a documentação de software não me refiro como é óbvio a APIs mas sim a relatórios, manuais etc....

Por exemplo a estrutura que usam para os relatórios, para a documentação do vosso software.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

http://www.doxygen.org/

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D.

Talvez seja isto que andas à procura?

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Não lol acho que isso foi exactamente o que eu disse que não queria :D Pelo menos foi o que percebi dessa ferramenta.

Não me refiro a documentar codigo mas sim a aplicação em si, como funciona, essas coisas :)

Em todo o caso thx

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Eu uso LaTeX para criar documentação, mas ainda não criei documentação de aplicações por isso não te posso ajudar quanto à estrutura.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Isso depende, eu geralmente tenho separado relatórios de manuais.

No relatório dou destaque ao sistema global em si, e depois foco nos sistemas individuais.

Nos manuais é referente a cada aplicação, mesmo que a solução final contenha várias aplicações.

Para relatórios começo com uma pequena introdução a descrever o objectivo de uma forma geral.

Depois passo para uma secção em que falo sobre o que foi feito de um modo geral, com esquemas, a descrever os vários sistemas ligados, hardware e software e como se interligam entre si. Depois passo para uma secção mais detalhada a falar de cada sistema em concreto e o que fazem, caso seja necessário também faço referências a requesitos necessários ou limitações.

Nos manuais descrevo a funcionalidade para cada aplicação, sendo um manual para cada aplicação/front-end.

Isto é, se tiver na solução uma aplicação num servidor, e também tiver uma página web para interagir com a aplicação.

Vai haver um manual para a aplicação e outro manual para a página web. A interligação deles e como funcionam, etc cabe ao relatório.

Nos manuais, começo com uma pequena introdução a falar do objectivo da aplicação, ou seja, para que serve aplicação. Depois costumo ter divido o manual por modos de utilização e para cada um screnshots ou algo do genéro para cada "ecrã" e dizer como é o funcionamento de cada ecrã.

Em certos tipos de aplicação, também posso incluír no final uma secção para em caso de problemas e como resolve-los. Erros relacionados com a lógica da aplicação, não refiro a erros tipo crashes e tal. Tipo, se for uma aplicação para interagir com uma impressora especifica e se der um erro relacionado com falta de papel, indicar que é necessário ir à impressora trocar de papel e de como trocar de papel.

Não sei se é isto que pretendias saber.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Em que formatos queres disponibilizar a documentação?

Eu na única vez que escrevi uma pequena documentação para o programa, usei LaTeX. Mas só disponibilizei uma versão em pdf da mesma. Para usar outros formatos, o LaTeX pode não ser a melhor opção.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

O formato não é grande problema o que queria mesmo era tipo um template lol

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Não sei ainda andas à procura de soluções, mas o txt2tags permite muita versatilidade de formatos sem ter que decorar sintaxes maradas.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Não sei ainda andas à procura de soluções, mas o txt2tags permite muita versatilidade de formatos sem ter que decorar sintaxes maradas.

Já tinha visto o teu post :( é engraçado pena não dar logo para PDF mas parece muito simples.

0

Partilhar esta mensagem


Link para a mensagem
Partilhar noutros sites

Crie uma conta ou ligue-se para comentar

Só membros podem comentar

Criar nova conta

Registe para ter uma conta na nossa comunidade. É fácil!


Registar nova conta

Entra

Já tem conta? Inicie sessão aqui.


Entrar Agora