DeComo empacotar seu pacote LaTeXtutorial:
"As partes importantes de um pacote são o código, a documentação do código e a documentação do usuário."
Qual é a diferença entre documentação do código e documentação do usuário?
Responder1
Bem, apesar do jjdb ter acertado em cheio com:
documentação do usuário = guia do usuário, documentação do código = guia do programador
Vou tentar ser um pouco mais poético:
O guia do usuário, como o próprio nome indica, é destinado ao usuário, ou seja, aquele cara que fica atrás do computador e usa seu código para fazer tudo o que precisa.
A documentação do código faz parte das boas práticas que um programador segue para acompanhar o que está fazendo, deixar mensagens claras para quem quiser mexer no código e manter a sanidade mental (principalmente ao voltar de longos períodos de trabalho). nenhuma interação com o código).
Basicamente, a documentação do usuário deve ser o mais explicativa possível, já que você não sabe qual é o nível de entendimento do pacote de quem está lendo (lembre-se que se esta for a primeira versão, provavelmente ninguém nunca viu antes), enquanto a documentação do código deve ser orientada para demonstrar o que seu código está fazendo e onde está fazendo, para que qualquer modificação possa ser feita da maneira mais fácil possível.