Docstrap

Docstrap
Projetos
Compartilhe

Gerador de documentação em PHP que cria um template usando Bootstrap, lendo arquivos escritos em linguagem Markdown.

Motivo da criação

Esta ferramenta foi criada para agilizar o processo de documentação de um projeto. A ideia foi ter uma maneira simples de escrever documentos durante o processo de desenvolvimento do projeto, por isso foi optado pelo uso da linguagem Markdown que é apenas uma marcação de texto, simples de aprender e elimina a atenção por detalhes visuais durante a escrita do documento.

Como usar?

Para usar, primeiramente baixe uma cópia da Ferramenta Docstrap e instale o arquivo em seu servidor PHP numa pasta onde irá escrever sua documentação, sugiro a pasta /doc. Logo depois leia os documentos no site da ferramenta para aprender como  organizar seus arquivos, como escrever sua documentação e veja alguns modelos de uso disponíveis.

Como colaborar?

Se deseja colaborar com a ideia ou pegar uma cópia para produzir sua própria versão, acesse o link do Repositório Docstrap no Github.

Comentários

comments powered by Disqus