it-swarm.com.de

Was ist eine gute Methode zum Erstellen eines Leitfadens für standardisierte Markups?

Ich muss einen Leitfaden oder ein Wiki erstellen, in dem verschiedene standardisierte Techniken zum Markieren wiederverwendbarer Elemente in unserer Software beschrieben werden. Wenn unsere Entwickler neue Funktionen hinzufügen, können sie vorhandene Markups häufig wiederverwenden oder nachahmen, und ich möchte dies für sie so einfach wie möglich gestalten. Um dies jetzt zu tun, müssen sie durch die Schnittstelle graben, um etwas zu finden, das nah genug ist.

Gibt es online gute Beispiele, die Codebeispiele für standardisiertes Markup zeigen?

Gibt es ein Tool (Wiki usw.), mit dem dies etwas einfach zu erstellen ist?

2
Brandon Durham

Microsoft Visual Studio verfügt über eine Funktion namens "Code-Snippets", mit der Entwickler diese Snippets erstellen und dann (mithilfe eines Menüs oder einer Tastenkombination) während der Bearbeitung schnell in das Caret einfügen können. Ich weiß, dass es meine Mitarbeiter sehr glücklich macht, weil sie weniger Boilerplate-Code schreiben und sich mehr auf die Geschäftslogik konzentrieren können. So sieht es aus:

enter image description here

Natürlich ist dieses Beispiel für Visual Basic, aber es gibt es auch für HTML und CSS oder für ein beliebiges Markup (z. B. XML). Sie können ein umfangreiches Steuerelement wie dieses anbieten, damit Ihre Entwickler ihre Snippets verwalten können. Das Bereitstellen von Dokumentation neben jedem Snippet sollte trivial sein.

Alternativ haben wir uns für etwas Leichteres in Handcraft entschieden. In unserem Tool bitten wir Designer, HTML-Prototypen mit einigen Tags zu HTML zu schreiben, um einige Dinge zu ermöglichen, die mit Vanilla HTML nicht möglich sind. Wir sind uns bewusst, dass einige Leute vor einer Lernkurve stehen werden, um sich darauf einzulassen. Daher wird jeder neue Benutzer mit einer Anleitung in das neue Markup eingeführt.

Der Leitfaden besteht aus einer Reihe von Schritten, in denen wir Sie durch das neue Markup und die Dinge führen, die Sie damit tun können, indem Sie interaktiven Tutorials folgen. Wir zeigen Ihnen einen Tag und bitten Sie dann, etwas zu tun. Es funktioniert ganz gut.

Die Art und Weise, wie wir den Leitfaden präsentieren, besteht darin, ein Accordeon-Steuerelement neben dem Code-Editor anzuzeigen. Wenn Sie beginnen, wird der erste Schritt erweitert, aber es gibt eine Schaltfläche "Nächster Schritt", die den ersten Schritt reduziert und den zweiten erweitert:

enter image description here

Wenn Sie ein weniger flexibles, aber einfacheres System als das von Visual Studio wünschen, können Sie Ihren Entwicklern möglicherweise ein Steuerelement wie unser Accordeon anbieten, mit dem sie standardisierte Markups (als "Snippets") schnell erkennen und bei Bedarf bearbeiten können. Ich kann mir vorstellen, dass Sie eher nach Zweck als nach Schritten in einem Prozess organisieren möchten.

1
Rahul