*Update4*Dokumentationssystem - Wie machst Du das ?

dreamcatcher · 13.12.2011, 21:15

Hallo,

bin auf der Suche nach einem System, womit ich mir selbst Tutorials o.Ä. zugänglich mache.

Aus Erfahrung kenne ich "Wikis", bei denen dann Logindaten, Tutorials o.Ä. gespeichert werden.

Das Problem an dem mir bekannten Wiki ist, dass die SuFu nicht anständig den Quellcode durchsucht und das eintragen nur mit kryptischen Zeichen formatiert wird.

Es sollte schon ein WYSIWYG Editor haben.

Kennst Du solche guten Systeme oder hast andere Vorschläge, wie man das am Besten organisiert ?

Wie machst Du das ?

Dreamcatcher

nikosch · 13.12.2011, 21:24

Was ist jetzt die konkrete Aufgabe? Kann mit dem Titel nichts anfangen.

Zitat:

womit ich mir selbst Tutorials o.Ä. zugänglich mache

Augen? Gehirn? Verstand?

drsoong · 13.12.2011, 23:15

Peile irgendwie gar nichts.

Ich lese Dokumentationssystem und denke an Bürosoftware.
Ich lese "mir selbst Tutorials zugänglich machen" und denke an Google.
Ich lese WYSIWYG Editor und denke: Hä?!

dreamcatcher · 14.12.2011, 00:14

Ich fange von hinten an, das Ziel ist folgendes:

Beispiele:
1.)
Ich benutze die SuFu des Programms um nach einem Codeschnipsel ausschau zu halten: Gebe als Keyword xyz in der Suche ein und er findet meinen zuvor erstellten Eintrag
2.)
Ich erstelle in der Software z.B. eine Tabelle oder kopiere diese aus Word mit Strg+C -> STRG +V in den Editor.
Nun möchte ich nicht irgendwas umformatieren, um ein simples Layout zu übernehmen.
Daher die Idee mit dem WYSIWYG Editor.
3.)
Als Inhalt kommen Logindaten, Codeschnipsel, selbst geschriebene Tutorials und alles was sich sonst in .txt o.Ä. Form ansammeln würde in Frage.
Sprich es ist mein ultimatives Nachschlagewerk für Dinge ich ich schnell benötige.

Eine Art elektronischer Duden.
---

Ich denke an etwas wie ein Wiki, da ich leicht bei einem OS Wechsel lokal darauf zugreifen kann.

Ich stelle mir außerdem eine Art Inhaltsverzeichnis auf der ersten Seite vor, mit Haupt- und Unterkapitel.

Auf dem Mac gibt es eine App für Programmierer, bei welchem man den Quellcode mit Notizen, Highlighting etc., aufbewahren kann.

Die App ist halt nur für den Mac und daher für mich nicht zu gebrauchen.

Mit einem Wort, ich bin auf der Suche nach meinem selbstgebauten ultimativen "Werkzeugkasten".

drsoong · 14.12.2011, 00:20

Aha, sozusagen Deine eigene heterogene Knowledge Base, was ?!

Der unterschiedlichen Formate, Kategorien, Themen wegen fiel mir spontan No-SQL ein.
Habe selber zwar nur darüber gelesen - also keine Praxis - würde aber mal anraten,
z. B. ein CouchDB-Einsteigertutorial durchzulesen.

nikosch · 14.12.2011, 01:12

Wie üblich bei Web-basierten CMS wird hier der Knackpunkt im Editor liegen. WYSIWYG klappt leidlich und ob das dann Suchkompatibel ist… nunja.
Je nach Prio könntest Du nach „Schnipselbibliothek“, „Outliner“ oder ähnlichem forschen. Meine persönliche Vorliebe wäre ein System mit Tagging-Unterstützung. Irgendwie bezweifle ich aber, dass es da brauchbares auf dem Markt gibt.

Meine 2. persönliche Vorliebe wäre hier eher ein Desktopprogramm. Die tun sich auch nicht so schwer mit WYSIWYG/Rich text (Stichwort RTF), laufen meist flüssiger und sind nicht abhängig, wenn mal der Browser abstürzt. Zudem ergibt sich hier nicht das Problem, dass Dateien ständig erst über Upload bereitgestellt werden müssen.

Ich evaluiere hier gerade TheGuide (ist aber eher ein Outliner), vielleicht findest Du auch ein kleines DMS oder eben einen Schnipselsammler, Todo-List-Tool oder dergl.

dreamcatcher · 14.12.2011, 03:52

Habe https://github.com/68kb/68kb gefunden, leider scheint der Mastertree abe corrupted zu sein und die alte Version 1 unterstützt zu wenig um produktiv damit umzugehen.

Bin gerad am testen von phpMyFAQ, sieht ganz nett aus... das ACP & UI ist etwas hakelig, fühle mich von der Technologie um 5 Jahre zurückversetzt... an sich bietet es aber schöne Funktionen die meinem Wunsch nahe kommen.

Ich evaluier gerade einfach ein Forum wie phpBB aufzusetzen mit entsprechenden Subforen, worin ich dann alle Artikel etc platziere.

Dann hab ich als Plugin Syntaxhighlighting, viele Editoren als Extensions verfügbar und eine Sitemap wirds sicher auch geben.

TheGuide ist für W7 fein, vor allem da portabel und kein Installationszwang, kommt für mich jedoch nicht in Frage, da nicht auf Macs ausführbar.

Update1://
PHPBB fällt raus, unterstützt aus "Sicherheitsgründen" keinen HTML Editor und ist via BBCodes nur sehr sehr eingeschränkt zu benutzen [Tabellen sind z.B. nicht möglich].

Dank Drsoong´s Suchbegriff bin ich auf folgendes gestoßen:
http://www.knowledgebase-script.com/

Sehr sehr teuer für meinen Einsatzzweck.
Habe nun eine Mail Zwecks Studentenrabatt rausgeschickt.

Update2://
Wie aus diesem Thread entnehmbar: http://www.php.de/off-topic-diskussi...ntation-2.html (Software zum erstellen von Manual/Dokumentation) eignet sich Dokuwiki wohl gut.

Problem nur, dass weder Syntaxhighlighting noch Tabellen anscheinend erstellt werden können.

Wie Nikosch auch sagte, ist der Editor dort sehr rudimentär, sprich es ist alles mit BBCode Zeugs.

Update3://
Ganz aktuell, vor einigen Stunden erst erschienen, WYSIWYG für Wikimedia:
http://winfuture.de/news,67141.html

Update4://
Ich nehme nun erstmal WikiMedia... der Editor ist durch die http://www.mediawiki.org/wiki/Extension:WikiEditor Extension etwas aufgebohrt.
Sobald das neue Plugin fertig ist (http://www.mediawiki.org/wiki/Extension:VisualEditor, siehe Textlink Update3) habe ich auch einen super Editor zur Verfügung.

Zwecks Codehighlighting nehme ich folgende Extension:
http://www.mediawiki.org/wiki/Extension:Code
(Achtung, dafür wird im gleichen Verzeichnis Geshi benötigt: http://sourceforge.net/projects/gesh...0.zip/download)

Und um die Artikel einfach zu publishen noch folgende Extension:
http://www.mediawiki.org/wiki/Extension:Collection

Zum einbetten von Videos:
http://www.mediawiki.org/wiki/Extension:EmbedVideo

Das ist erstmal eine annehmbare Lösung.

Themen-Optionen
Druckbare Version zeigen Jemanden per E-Mail auf dieses Thema hinweisen
Thema bewerten
Thema bewerten:

Ähnliche Themen
Thema	Autor	Forum	Antworten	Letzter Beitrag
Du machst ! Ich zahle !	ichkanns	Sonstige	1	30.12.2010 20:42
Dokumentationssystem		Beitragsarchiv	1	17.09.2004 18:59

13.12.2011, 21:15
dreamcatcher Erfahrener Benutzer Registriert seit: 28.12.2010 Beiträge: 602 PHP-Kenntnisse: Anfänger	Update4Dokumentationssystem - Wie machst Du das ? Hallo, bin auf der Suche nach einem System, womit ich mir selbst Tutorials o.Ä. zugänglich mache. Aus Erfahrung kenne ich "Wikis", bei denen dann Logindaten, Tutorials o.Ä. gespeichert werden. Das Problem an dem mir bekannten Wiki ist, dass die SuFu nicht anständig den Quellcode durchsucht und das eintragen nur mit kryptischen Zeichen formatiert wird. Es sollte schon ein WYSIWYG Editor haben. Kennst Du solche guten Systeme oder hast andere Vorschläge, wie man das am Besten organisiert ? Wie machst Du das ? Dreamcatcher Geändert von dreamcatcher (14.12.2011 um 23:40 Uhr).


Mister Ad PHP Code Flüsterer Registriert seit: 21.08.2005 Beiträge: 4682 PHP-Kenntnisse: Fortgeschritten

13.12.2011, 23:15
drsoong Erfahrener Benutzer Registriert seit: 05.08.2008 Beiträge: 1.127	Peile irgendwie gar nichts. Ich lese Dokumentationssystem und denke an Bürosoftware. Ich lese "mir selbst Tutorials zugänglich machen" und denke an Google. Ich lese WYSIWYG Editor und denke: Hä?! __________________ Es ist schon alles gesagt. Nur noch nicht von allen.

14.12.2011, 00:14
dreamcatcher Erfahrener Benutzer Registriert seit: 28.12.2010 Beiträge: 602 PHP-Kenntnisse: Anfänger	Ich fange von hinten an, das Ziel ist folgendes: Beispiele: 1.) Ich benutze die SuFu des Programms um nach einem Codeschnipsel ausschau zu halten: Gebe als Keyword xyz in der Suche ein und er findet meinen zuvor erstellten Eintrag 2.) Ich erstelle in der Software z.B. eine Tabelle oder kopiere diese aus Word mit Strg+C -> STRG +V in den Editor. Nun möchte ich nicht irgendwas umformatieren, um ein simples Layout zu übernehmen. Daher die Idee mit dem WYSIWYG Editor. 3.) Als Inhalt kommen Logindaten, Codeschnipsel, selbst geschriebene Tutorials und alles was sich sonst in .txt o.Ä. Form ansammeln würde in Frage. Sprich es ist mein ultimatives Nachschlagewerk für Dinge ich ich schnell benötige. Eine Art elektronischer Duden. --- Ich denke an etwas wie ein Wiki, da ich leicht bei einem OS Wechsel lokal darauf zugreifen kann. Ich stelle mir außerdem eine Art Inhaltsverzeichnis auf der ersten Seite vor, mit Haupt- und Unterkapitel. Auf dem Mac gibt es eine App für Programmierer, bei welchem man den Quellcode mit Notizen, Highlighting etc., aufbewahren kann. Die App ist halt nur für den Mac und daher für mich nicht zu gebrauchen. Mit einem Wort, ich bin auf der Suche nach meinem selbstgebauten ultimativen "Werkzeugkasten".

14.12.2011, 00:20
drsoong Erfahrener Benutzer Registriert seit: 05.08.2008 Beiträge: 1.127	Aha, sozusagen Deine eigene heterogene Knowledge Base, was ?! Der unterschiedlichen Formate, Kategorien, Themen wegen fiel mir spontan No-SQL ein. Habe selber zwar nur darüber gelesen - also keine Praxis - würde aber mal anraten, z. B. ein CouchDB-Einsteigertutorial durchzulesen. __________________ Es ist schon alles gesagt. Nur noch nicht von allen.

14.12.2011, 01:12
nikosch moderatives Dielektrikum Registriert seit: 21.05.2008 Beiträge: 35.987 PHP-Kenntnisse: Fortgeschritten	Wie üblich bei Web-basierten CMS wird hier der Knackpunkt im Editor liegen. WYSIWYG klappt leidlich und ob das dann Suchkompatibel ist… nunja. Je nach Prio könntest Du nach „Schnipselbibliothek“, „Outliner“ oder ähnlichem forschen. Meine persönliche Vorliebe wäre ein System mit Tagging-Unterstützung. Irgendwie bezweifle ich aber, dass es da brauchbares auf dem Markt gibt. Meine 2. persönliche Vorliebe wäre hier eher ein Desktopprogramm. Die tun sich auch nicht so schwer mit WYSIWYG/Rich text (Stichwort RTF), laufen meist flüssiger und sind nicht abhängig, wenn mal der Browser abstürzt. Zudem ergibt sich hier nicht das Problem, dass Dateien ständig erst über Upload bereitgestellt werden müssen. Ich evaluiere hier gerade TheGuide (ist aber eher ein Outliner), vielleicht findest Du auch ein kleines DMS oder eben einen Schnipselsammler, Todo-List-Tool oder dergl. __________________ -- One pixel is still too big. Please make it smaller. ASAP. Initiative Mittelstand. Die wichtigste Gestaltungsregel im Screendesign ist Pi mal Daumen des Arbeitgebers. --

14.12.2011, 03:52
dreamcatcher Erfahrener Benutzer Registriert seit: 28.12.2010 Beiträge: 602 PHP-Kenntnisse: Anfänger	Habe https://github.com/68kb/68kb gefunden, leider scheint der Mastertree abe corrupted zu sein und die alte Version 1 unterstützt zu wenig um produktiv damit umzugehen. Bin gerad am testen von phpMyFAQ, sieht ganz nett aus... das ACP & UI ist etwas hakelig, fühle mich von der Technologie um 5 Jahre zurückversetzt... an sich bietet es aber schöne Funktionen die meinem Wunsch nahe kommen. Ich evaluier gerade einfach ein Forum wie phpBB aufzusetzen mit entsprechenden Subforen, worin ich dann alle Artikel etc platziere. Dann hab ich als Plugin Syntaxhighlighting, viele Editoren als Extensions verfügbar und eine Sitemap wirds sicher auch geben. TheGuide ist für W7 fein, vor allem da portabel und kein Installationszwang, kommt für mich jedoch nicht in Frage, da nicht auf Macs ausführbar. Update1:// PHPBB fällt raus, unterstützt aus "Sicherheitsgründen" keinen HTML Editor und ist via BBCodes nur sehr sehr eingeschränkt zu benutzen [Tabellen sind z.B. nicht möglich]. Dank Drsoong´s Suchbegriff bin ich auf folgendes gestoßen: http://www.knowledgebase-script.com/ Sehr sehr teuer für meinen Einsatzzweck. Habe nun eine Mail Zwecks Studentenrabatt rausgeschickt. Update2:// Wie aus diesem Thread entnehmbar: http://www.php.de/off-topic-diskussi...ntation-2.html (Software zum erstellen von Manual/Dokumentation) eignet sich Dokuwiki wohl gut. Problem nur, dass weder Syntaxhighlighting noch Tabellen anscheinend erstellt werden können. Wie Nikosch auch sagte, ist der Editor dort sehr rudimentär, sprich es ist alles mit BBCode Zeugs. Update3:// Ganz aktuell, vor einigen Stunden erst erschienen, WYSIWYG für Wikimedia: http://winfuture.de/news,67141.html Update4:// Ich nehme nun erstmal WikiMedia... der Editor ist durch die http://www.mediawiki.org/wiki/Extension:WikiEditor Extension etwas aufgebohrt. Sobald das neue Plugin fertig ist (http://www.mediawiki.org/wiki/Extension:VisualEditor, siehe Textlink Update3) habe ich auch einen super Editor zur Verfügung. Zwecks Codehighlighting nehme ich folgende Extension: http://www.mediawiki.org/wiki/Extension:Code (Achtung, dafür wird im gleichen Verzeichnis Geshi benötigt: http://sourceforge.net/projects/gesh...0.zip/download) Und um die Artikel einfach zu publishen noch folgende Extension: http://www.mediawiki.org/wiki/Extension:Collection Zum einbetten von Videos: http://www.mediawiki.org/wiki/Extension:EmbedVideo Das ist erstmal eine annehmbare Lösung. Geändert von dreamcatcher (15.12.2011 um 01:22 Uhr).