Was ist eine gute Lösung, Business-Rule-Dokumentation für das Sammeln? [geschlossen]

https://stackoverflow.com/questions/1429937

07-07-2019
|

Frage

Ich bin in einer Situation ausgeführt wird, gemeinsam Ich bin sicher, wo meine Geschäftsregel-Dokumentation über E-Mails verbreitet wird, Dokumentation (jetzt veraltet) und IMs. Das stinkt.

kann ich mir vorstellen 2 Alternativen: Sharepoint (hasse es, die Suchfunktion ist schrecklich) oder ein Wiki.

Einige Dinge, die Ich mag würde in der idealen Lösung, um zu sehen:

leicht aktualisierbar : Sie machen mich Wort nicht nach oben ziehen Sie die Dokumentation aktualisieren
Diff Ansicht : Manchmal braucht man nur, um zu sehen, was neu ist
abonnierbar' : Benachrichtigung über neue Änderungen auf einer Seite für Seite Basis
Rollenbasierter : Bearbeiten und Anzeigen von Seiten können auf Rollen gebunden werden
Anhänge :. Einfache Aufnahme von Mockups, Dateien usw.
Suchen : Es ist ein Beitrag google Welt, möchte ich in der Lage sein, sofort zu suchen und finden - Sharepoint in dieser Kategorie verliert, es sei denn das, was wir nicht ordnungsgemäß verwenden
Anhang Einschränkung : Im Idealfall wäre die Lösung nicht das Hochladen eines Bündels von Word-Dokumente ermöglichen, die wir würden dann unsere Dokumentation nennen. Ich mag die Dokumentation ein einheitliches (und einfach) Format zu haben. Erzwingen Anhänge als PDF, txt und so weiter.

Following auf meinem Wiki Kommentar es sieht aus wie es mindestens 3 Wikis , die das tun, was ich will (Incentive, Sharepoint-Wiki-plus, ThoughtFarmer). ThoughtFarmer, lieben diesen Namen.

Lösung

+ 10⁶ für ein Wiki, es ist die beste Lösung, die ich für die Dokumentation bisher gefunden habe, vor allem der technische Dokumentation. IMO, sind die Vorteile von „gut“ Wiki Motoren über Office-Dokumente in einer VCS (aber du bist schon bewusst, dass diese Liste Funktionen Ihrer Anforderungen sehr nahe ist):

Sie sind nur schneller und einfacher zu bedienen als Office-Dokumente in einer VCS (keine Notwendigkeit, das VCS-Client zu öffnen, die neueste Version Kasse, optional sperrt, öffnen Sie Wort, speichert, Check-in, die Sperre)
Sie sind textbasiert, so dass Sie diffs machen (im Gegensatz zu Wort) und diese nur eine haben muss
Sie bieten Benachrichtigungsmechanismen (zum Beispiel E-Mail, RSS) und so wird die Information an Dich gedrückt (im Gegensatz zu einem VCS, wo Sie brauchen Dokument zu ziehen, wenn sie veraltet sind)
gibt es keine „Dokument von einem anderen Benutzer Problem gesperrt“, weil jemand um sie zu lösen vergessen (wenn Sie exklusive Sperre verwenden, die häufig auf Dokumente der Fall ist, dass Sie nicht fusionieren können)
Seiten leicht Refactoring, neu organisiert, zusammengebaut werden in größeren Dokumenten
Sie sind wirklich kollaborativen
Sie bieten viel bessere Unterstützung für Code (zum Beispiel direkt auf den Quellcode in einer VCS mit viel besseren Formatierung als in Wort verweisen kann)
Sie können Index der Inhalt der Seiten und beigefügten Unterlagen (pdf, Office-Dokumente, etc.) und machen es durchsuchbar

Das einzige Problem, das ich konfrontiert habe, wenn ein Wiki für die Dokumentation ist, dass es schwieriger zu Version Ihrer Dokumentation in der gleichen Zeit wie der Code (das heißt Sie Version x.y.z liefern und mag die Dokumentation dieser Version „lock“). Ich habe verwendet Exporte dieses Problem zu lösen, aber es ist nicht perfekt.

ich gearbeitet habe bereits mit ~~TWiki~~ Foswiki , Confluence und XWiki . Sie sind alle „gut“ Wiki-Motoren (wie oben definiert) und alle Ihre Anforderungen entsprechen. So ist die letzte Wahl nur kann auf Einschränkungen abhängen (Lizenz, Preise, Technik) und persönliche Vorlieben.

Ab heute würde ich Confluence wählen, ob ein kommerzielles Werkzeug eine Option, XWiki, wenn nicht.

Andere Tipps

Eine off-the-wall Idee ist, schauen Sie in FitNesse . Es ist ein Wiki, in erster Linie dem Ziel, Geschäftsregeln zu beschreiben (oder Abnahmeanforderungen) als Tests.

Ich bin ein zu entwickeln.

Vor etwa ein Jahr habe ich nach Anforderungsmanagement-Software auf dem ‚Netz und mindestens 30 von ihnen, in etwa 3 Kategorien gefunden:

Priceless (und zum Beispiel bei Luftfahrtunternehmen im Handel)
Teure (z 1000s $ pro Sitz), die mein Arbeitgeber hat nie verwenden gewählt
Billige oder kostenlos, aber fehlende Features, die mir wichtig erscheinen

Es gibt auch allgemeine Zwecke Werkzeuge (z Wiki, oder E-Mails und Word-Dokumente und / oder Tabellen), die zu fehlen Features, die mir wichtig erscheinen.

Ich denke, Sie sollten neu erarbeiten: „Features fehlen, die mir wichtig erscheinen“.

Es gibt Dinge, die Sie können tun mit einem Universal Wiki:

Erstellen Sie eine Liste der Funktionen
Beschreiben Sie jede Funktion (vielleicht eine eigene Seite / Abschnitt für jede Funktion)
Sie diese kollaborativ (Versionskontrolle, Update-Benachrichtigungen, Diskussionsseiten)

Aber es gibt einige Dinge, die ich glaube, Sie nicht mit einem Universal tun können Wiki, auch ziemlich grundlegende Dinge:

benutzerdefinierte Attribute definieren (zum Beispiel "Datum gestartet", "Geschätzte Kosten", etc.); diese Attributwerte mit Ihren Funktionen verknüpfen; Liste Funktionen (in einer Tabelle oder ein Gitter) mit ihren Attributen (so dass sie sortiert werden kann, beispielsweise durch „Wichtigkeit“ sortierten oder durch „Schwierigkeit“)
Hilfe für die Rückverfolgbarkeit (Traceability nicht allzu schwierig, wenn es nur zwei Stufen, zB „Anforderungen“ und „Umsetzung“, aber es ist schwieriger, wenn es mehrere Stufen, zB „Use Cases“ sind, „functional spec“, "Architektur", "Details der Implementierung", "Testfälle", "Testergebnisse" und "Fehlermeldungen")
Support strukturierte Informationen, das heißt Teilabschnitte und nicht nur Top-Level-Abschnitte.

Auch einfaches Editieren ist nicht schön, wie es sein sollte. Geschäftsleute könnten Verwendung eines MS Word UI für die Bearbeitung bevorzugen aber MS Word erzeugt Dokumente, das heißt „Informationssilos“; aber wenn Sie MS-Word nicht verwenden, dann sind Sie mit, was? Ein WYSIWYG-In-Browser-Editor? Oder Abschlag Syntax?

Ich mag die Wiki-Funktion für diese in FogBugz gebaut verwenden, vorausgesetzt, verwenden Sie es bereits für Feature / Bug-Tracking. Es ist praktisch, dass Informationen in dem gleichen Werkzeug zu haben.

Drupal erfüllt Ihre Anforderungen aufgelistet, es ist sehr dehnbar mit Lasten von Modulen (etwas weiter unten) und es ist verfügbar unter der GPL.

Wir haben JIRA auf einem früheren Projekt verwendet Regeln rund 750 verschiedenen Unternehmen zu speichern. JIRA ist meist / irgendwie-ein Bug-Tracking-Tool, aber es ist so mächtig und individuell anpassbare, dass Sie es für alle Arten von Workflow / Prozess / Wissensbasis Situationen nutzen können. . (BTW - ich weiß nicht für das Unternehmen arbeiten, die es produziert)

leicht aktualisierbar: yes
Diff Ansicht: eine vollständige Änderungshistorie ist verfügbar
abonnierbar': ja, hat die Idee der "Watch-Listen"
Rollenbasierter: ja, funktionsreiche Sicherheitsmodell
Anhänge: ja, jede Regel kann seine eigene Anhänge
Suche: ja, Volltextsuche verfügbar
Anhang Einschränkung:. Hmm - über dieses man nicht sicher und genau das, was Sie zu tun versuchen

Einige Tipps, wenn Sie diesen Weg zu gehen entscheiden ...

Nutzen Sie JIRA die anpassbare IDs an anderer Stelle von der Regel beziehen sich z.B. MYPRJ-334
Haben Sie klare Richtlinien darüber, was das, was besagt, Sie planen Mittel zu verwenden, vorgeschlagen, gebilligt, Implementiert, bestätigt, Dropped.
Die einzige Definition einer Regel in der Beschreibung ist - alle Kommentare sind nur Kommentare
Sie können Regel verlinken auf Fälle zu verwenden, Komponenten unabhängig

Es ist ein großer Ansatz und ich würde es wirklich empfehlen.

Lizenziert unter: CC-BY-SA mit Zuschreibung

Nicht verbunden mit StackOverflow