Ferramenta semelhante a Wiki para escrever especificações e documentação [fechada]


9

Estou procurando um wiki ou um sistema semelhante ao wiki para escrever e gerenciar especificações e documentação para um projeto de software.

Eu sei que existem muitas implementações wiki disponíveis, mas existem algumas que são especialmente adequadas para esse tipo de tarefa?

Na verdade, ele não precisa ser um wiki, apenas um sistema que facilita a escrita e a navegação de especificações e documentação, e que suporta o rastreamento de alterações.


11
Você está usando uma plataforma especial? Como o TFS da Microsoft, por exemplo?
Saeed Neamati 01/09/11

Seguindo o que o @Saeed pediu, que tipos de infraestrutura sua equipe / organização já possui para gerenciamento e compartilhamento de conhecimento? Além disso, quais são seus processos atuais para escrever especificações e documentos?
Thomas Owens

Respostas:


6

Estamos usando LaTeX e SVN. Como os documentos LaTeX são apenas arquivos de texto, ele funciona bem com o controle de versão, diferentemente de alguns formatos binários ou parcialmente binários.

Você obtém todas as vantagens (e desvantagens, reconhecidamente) do controle de versão com o qual está acostumado ao usá-lo com seu código.

O LaTeX requer um pouco de configuração (para definir seus próprios estilos / classe), mas uma vez feito isso, é muito bom - você pode se concentrar apenas no conteúdo, e não na sua apresentação (em vez de ficar tentado a ajustar constantemente enquanto está com WYSIWYG), mas ainda assim obtém um documento PDF elegante e com aparência profissional no final.


4

Pessoalmente, gosto muito do Tiddly Wiki .

Ele tem uma sintaxe wiki bastante completa, é um arquivo html único e funciona bem com uma variedade de navegadores da web sem a necessidade de um servidor.

Ele ainda possui uma arquitetura de plugins extensível, que permite adicionar plug-ins para fazer todo tipo de coisa interessante, como criptografar tiddlers ou adicionar notas de rodapé.


3

Para a plataforma Microsoft, a integração do TFS (Team Foundation Server) com o SharePoint é exatamente o que você está procurando. Ao criar um novo projeto de equipe, você pode escolher um modelo que abrange quase todos os aspectos do processo de desenvolvimento de software. Ele fornece um portal no qual você pode definir os membros da equipe, atribuir suas funções e permissões de segurança, fazer upload, compartilhar e editar documentos e especificações relacionados ao seu projeto, além de fazer muitas outras coisas interessantes com ele.

Para outras plataformas, acho que você pode usar algo como o GitHub (no entanto, não tenho certeza).


0

Para o projeto pessoal (existente apenas no meu PC), uso o Wiki em um jar . No passado, trabalhei com o Redmine (ele também possui um sistema de rastreamento de bugs e SCM)


0

Você pode experimentar o Sphinx , com os documentos verificados na infraestrutura de gerenciamento de controle de origem de sua escolha. Isso tem as vantagens do controle de origem e uma linguagem de marcação relativamente leve, reStructuredText , fácil de aprender e muito bem instrumentada para conversões (para HTML, PDF e assim por diante).

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.