O que é uma boa solução para a recolha de documentação regra de negócio? [fechadas]

https://stackoverflow.com/questions/1429937

07-07-2019
|

Pergunta

Eu estou correndo em uma situação, comum eu tenho certeza, onde minha documentação regra de negócio é espalhados por e-mails, a documentação (agora fora de data) e mensagens instantâneas. Isso fede.

Não consigo pensar em 2 alternativas: Sharepoint (odeio isso, o recurso de busca é terrível) ou um wiki.

Algumas coisas que eu gostaria de ver na solução ideal:

facilmente atualizável : não me faça puxar para cima Word para atualizar os docs
Vista Diff : Às vezes, você só precisa ver o que há de novo
Registrável : Notificação de novas mudanças em uma página por página
base Função : edição e visualização de páginas pode ser vinculada a papéis
Anexos :. Fácil inclusão de maquetes, arquivos etc
Pesquisar : É um mundo pós google, eu quero ser capaz de pesquisar e encontrar instantaneamente - Sharepoint perde, nesta categoria, a menos que o que usamos está configurado incorretamente
Restrição Anexo : Idealmente, a solução não permitiria o upload de um monte de documentos do Word que tínhamos em seguida, chamar a nossa documentação. Eu gostaria a documentação para ter um formato consistente (e simples). Impor anexos como PDF, TXT e assim por diante.

No seguimento do meu comentário wiki parece que existem pelo menos 3 wikis que fazer o que eu quero (Incentivo, SharePoint-Wiki-Plus, ThoughtFarmer). ThoughtFarmer, amo esse nome.

Solução

+ 106 para um Wiki, que é a melhor solução que eu encontrei até agora para documentação, especialmente documentação técnica. IMO, as vantagens de "boas" motores Wiki mais de documentos do Office em um VCS são (mas você já está ciente de que, como esta lista de recursos é muito próximo com suas exigências):

eles são apenas mais rápido e mais fácil de usar do que documentos do Office em um VCS (sem necessidade de abrir o cliente VCS, verificação geral a versão mais recente, opcionalmente bloqueá-lo, palavra abrir, salvar, check-in, liberar o bloqueio)
são baseados em texto para que você faça diffs (ao contrário de palavra) e este apenas um deve ter
que oferecem mecanismos de notificação (por exemplo, e-mail, RSS) e assim a informação é empurrado para você (ao contrário de um VCS onde você precisa documento puxar quando eles estão fora de data)
não existe um "documento bloqueado por outro problema do usuário", porque alguém se esqueceu de liberá-lo (se você estiver usando o bloqueio exclusivo que é frequentemente o caso em documentos que você não pode mesclar)
páginas podem ser facilmente reformulado, reorganizada, reunidos em documentos maiores
eles são realmente colaborativo
fornecem suporte muito melhor para o código (por exemplo, você pode apontar diretamente no código-fonte em um VCS com muito melhor formatação do que na palavra)
eles podem indexar o conteúdo de páginas e documentos anexos (PDF, documentos do Office, etc) e torná-lo pesquisável

O único problema que tenho enfrentado ao usar um Wiki para documentação é que é mais difícil para a versão a documentação no mesmo tempo que o seu código (ou seja, você entregar versão x.y.z e quer "bloqueio" a documentação desta versão). Eu usei as exportações para resolver isso, mas ele não é perfeito.

Eu já trabalhei com ~~TWiki~~ Foswiki , Confluence e XWiki . Eles são todos os motores Wiki "boas" (conforme definido acima) e todos se encontram suas necessidades. Assim, a escolha final pode apenas depender de suas restrições (licença, preços, tecnologia) e preferências pessoais.

A partir de hoje, eu escolheria Confluence se uma ferramenta comercial é uma opção, XWiki se não.

Outras dicas

A mais off-the-wall idéia é olhar para FitNesse . É um wiki, destinado principalmente a descrever regras de negócio (ou requisitos de aceitação) como testes.

Estou desenvolvendo um.

Cerca de um ano atrás, eu olhei para o software de gerenciamento de requisitos sobre a 'net e encontrou pelo menos 30 deles, em aproximadamente 3 categorias:

inestimável (e comercializado, por exemplo, em empresas aeroespaciais)
Expensive (por exemplo, US $ 1,000 por assento), que meus empregadores nunca escolhido para uso
barato ou gratuito, mas características ausentes que me parecem importantes

Há também ferramentas de uso geral (por exemplo Wiki ou e-mails e documentos do Word e / ou planilhas), que apresenta também estão em falta que me parecem importantes.

Eu acho que você deve elaborar re: "está faltando características que me parecem importantes".

Existem coisas que você pode fazer com um de uso geral Wiki:

Criar uma lista de recursos
descrevem cada elemento (talvez uma página / seção separada para cada recurso)
Faça isso de forma colaborativa (controle de versão, notificações de atualização, páginas de discussão)

Mas, há algumas coisas que eu acho que você não pode fazer com um general-purpose Wiki, até mesmo coisas muito básicas:

Definir atributos personalizados (por exemplo "Data de início", "Custo estimado", etc.); associar esses valores de atributos com os seus recursos; características da lista (em uma mesa ou grade) com seus atributos (de modo que eles podem ser classificados, por exemplo, classificadas por "Importância" ou por "dificuldade")
Ajuda com rastreabilidade (rastreabilidade não é muito difícil quando existem apenas duas etapas, por exemplo, "requisitos" e "implementação"; mas é mais difícil quando há várias etapas, por exemplo, "casos de uso", "especificação funcional", "arquitetura", "detalhes de implementação", "casos de teste", "resultados do teste" e "relatórios de bugs")
Suporte estruturada da informação, ou seja, subseções e não apenas seções de nível superior.

Mesmo simplesmente editando não é um bom como deveria ser. Os empresários podem preferir o uso de uma interface do usuário MS Word para edição, mas MS Word produz documentos, ou seja, "silos de informação"; mas se você não usar o MS Word, então você está usando o quê? Um editor WYSIWYG no navegador? Ou sintaxe markdown?

Eu gosto de usar o recurso Wiki embutido no FogBugz para isso, assumindo que você já usá-lo para rastreamento recurso / bug. É útil ter essa informação na mesma ferramenta.

Drupal atenda às suas necessidades listadas, é altamente extensível com cargas de módulos (ver alguns abaixo) e está disponível sob a GPL.

Temos usado JIRA em um projeto anterior para armazenar cerca de 750 regras de negócio diferentes. JIRA é principalmente / meio-de uma ferramenta de rastreamento de bugs, mas é tão poderoso e personalizável que você pode usá-lo para todos os tipos de situações de fluxo de trabalho / processo / base de conhecimento. (BTW - Eu não trabalho para a empresa que o produz).

facilmente atualizável: sim
Diff: um histórico de alterações completo está disponível
Registrável: sim, tem a idéia de "watch-listas"
Role base: sim, o recurso de modelo de segurança rica
Anexos: sim, cada regra pode ter o seu próprio anexos
Pesquisar: sim, pesquisa de texto completo disponível
Anexo Restrição:. Hmm - não tenho certeza sobre este e exatamente o que você está tentando fazer

Algumas dicas se você decidir ir por esse caminho ...

Fazer uso de outros lugares do ID customizáveis ??do JIRA para se referir à regra, por exemplo, MYPRJ-334
ter orientações claras sobre o que o que quer que afirma que você pretende usar média, proposto, aprovado, implementado, Verificado, Caiu.
A única definição de uma regra é na descrição - todos os comentários são apenas comentários
Você pode vincular regra para casos de uso, os componentes que quer

É uma excelente abordagem e eu realmente recomendo.

Licenciado em: CC-BY-SA com atribuição

Não afiliado a StackOverflow