Lernen Sie die Schritte und Tipps zum Erstellen und Verwalten von Dokumentationsstandards und -vorlagen für Ihre Softwaredokumentationsprojekte kennen. Richten Sie sie mit Ihrer Zielgruppe und Ihren Zielen aus, recherchieren und vergleichen Sie die Best Practices, dokumentieren und testen Sie sie, kommunizieren Sie

Create a central repository for the document for easy maintenance and easy updates. Using version control tools like Git or Bitbucket is useful. Adding visuals in the document is easy to interpret. Draw.io or Lucidchart are tools to look into.

Wie erstellen und pflegen Sie Dokumentationsstandards und Vorlagen?

Bereitgestellt von KI und der LinkedIn Community

Dokumentationsstandards und -vorlagen sind wichtige Werkzeuge, um Konsistenz, Qualität und Effizienz in Ihren Softwaredokumentationsprojekten zu gewährleisten. Sie helfen Ihnen, das Format, den Stil, den Ton und die Struktur Ihrer Dokumentation sowie die Prozesse und Best Practices für die Erstellung und Aktualisierung zu definieren. In diesem Artikel erfahren Sie, wie Sie Dokumentationsstandards und -vorlagen für Ihre Softwaredokumentationsprojekte erstellen und pflegen.

Top-Expert:innen in diesem Artikel

Von der Community unter 9 Beiträgen ausgewählt. Mehr erfahren

1 Identifizieren Sie Ihre Zielgruppe und Ziele

Bevor Sie Ihre Dokumentationsstandards und -vorlagen erstellen, müssen Sie Ihre Zielgruppe und die Ziele Ihrer Dokumentation identifizieren. Für wen schreibst du? Was sind ihre Bedürfnisse, Erwartungen und Vorlieben? Was sind die Hauptziele und Ergebnisse Ihrer Dokumentation? Wie werden Sie den Erfolg messen? Diese Fragen helfen Ihnen, Ihre Dokumentationsstandards und -vorlagen an Ihre Zielgruppe und Ihre Ziele anzupassen.

Fügen Sie Ihre Sichtweise hinzu

Ilya Rozhansky

Architect / Senior Software Developer at Sayiqan LTD ASP.NET | .NET Core | C# | SQL Server | HTML | OOP
Beitrag melden
For me as a software developer the most important is the project document, which is written first of all for developers who didn't worked on the project, but at some point were asked to introduce some change/improvement. The project must include the following: -Purpose. -Description. -Source safe location. -Executable information (including required files to run application). -Log file description and location. -Input, including which DB tables application reads to start. -Output, including which DB tables were updated. -Application components, including ALL DB objects and installation package. -Detailed workflow. -Installation process. -List of all changes and updates since project release. -If necessary, how to monitor the application.

Übersetzt

Gefällt mir
Sunita Giri

Lead - Product Management Documentation at Everise | Product Documentation Specialist | CSPO Certified
Beitrag melden
Stakeholder analysis before creating the document helps to plan the document well. Their needs and understanding regarding the requirements or their pain points help to visualize the document and create them accordingly.

Übersetzt

Gefällt mir

2 Recherche und Benchmarking

Als Nächstes müssen Sie die vorhandenen Dokumentationsstandards und -vorlagen in Ihrer Branche, Ihrem Bereich und Ihrer Organisation recherchieren und vergleichen. Was sind die gängigen Konventionen, Formate und Stile, die von anderen Software-Dokumentationsprojekten verwendet werden? Was sind die Best Practices und Empfehlungen von Berufsverbänden, Normungsorganisationen und Experten? Was sind die spezifischen Anforderungen und Richtlinien Ihrer Stakeholder, Kunden oder Aufsichtsbehörden? Diese Quellen helfen Ihnen dabei, die Baseline und die Benchmarks für Ihre Dokumentationsstandards und -vorlagen festzulegen.

Fügen Sie Ihre Sichtweise hinzu

Kathy Bright

Award-winning technical and business writer/editor, solid IT business analyst, and experienced project manager. Working knowledge of usability and accessibility,
Beitrag melden
When possible, a client site visit can be invaluable. Watching users interact with the current system can reveal a lot. Also look at their notes, post-its, and any cheat sheets they've made. Bring a copy of the manual and ask users to find specific information. Do they flip through? Use the index or ToC? Can they find the right information fast? Focus groups are another useful tool to see what users need, want, use, and consider important. Another tool I've used when it's a new system and there's no end-users yet: trade magazines. There's a publication, site, or organization for almost everything. A little creative sleuthing about your users can go a long way to creating better and more relevant documentation.

Übersetzt

Gefällt mir

3 Erstellen und Dokumentieren

Sobald Sie die notwendigen Informationen und Erkenntnisse gesammelt haben, können Sie mit der Erstellung und Dokumentation Ihrer Dokumentationsstandards und -vorlagen beginnen. Sie können verschiedene Tools und Methoden verwenden, wie z. B. Textverarbeitungsprogramme, Tabellenkalkulationsprogramme, Styleguides, Checklisten, Flussdiagramme, Diagramme oder Code-Snippets, um Ihre Dokumentationsstandards und -vorlagen zu erstellen und zu dokumentieren. Sie sollten auch klare Erklärungen, Beispiele und Anweisungen zur Verwendung beifügen. Sie sollten auch Ihre Dokumentationsstandards und -vorlagen testen und validieren, um sicherzustellen, dass sie korrekt, vollständig und verwendbar sind.

Fügen Sie Ihre Sichtweise hinzu

Sunita Giri

Lead - Product Management Documentation at Everise | Product Documentation Specialist | CSPO Certified
Beitrag melden
Create a central repository for the document for easy maintenance and easy updates. Using version control tools like Git or Bitbucket is useful. Adding visuals in the document is easy to interpret. Draw.io or Lucidchart are tools to look into.

Übersetzt

Gefällt mir
Kathy Bright

Award-winning technical and business writer/editor, solid IT business analyst, and experienced project manager. Working knowledge of usability and accessibility,
Beitrag melden
A style guide is a great resource. You can use one that exists, like Microsoft's or Wired's, or create your own. A simple, reusable style "guide" could consist of one good writing reference and a single sheet of paper. Divide the paper into 8 sections (labeled ABC, DEF, GHI, etc) and write in any product names or other info as it should appear in documents. List fonts and colors. Consistent documentation is not only good for the user, but it can also reflect the company's brand. As a judge of technical writing competitions, I've seen how much "style" can vary from one company to the next, all of it unique, and all of it working. I like to say that good documentation helps users get their tasks done so they can go home on time.

Übersetzt

Gefällt mir

4 Kommunizieren und trainieren

Nachdem Sie Ihre Dokumentationsstandards und -vorlagen erstellt und dokumentiert haben, müssen Sie Ihr Dokumentationsteam und andere Beteiligte in der Verwendung dieser Standards kommunizieren und schulen. Sie sollten Ihre Dokumentationsstandards und -vorlagen mit Ihrem Team teilen und deren Feedback und Vorschläge einholen. Sie sollten auch Schulungen, Workshops, Webinare oder Tutorials anbieten, um zu erfahren, wie Sie Ihre Dokumentationsstandards und -vorlagen auf Ihre Dokumentationsprojekte anwenden können. Sie sollten auch alle Änderungen oder Überarbeitungen an Ihren Dokumentationsstandards und -vorlagen dokumentieren und aktualisieren.

Fügen Sie Ihre Sichtweise hinzu

Kathy Bright

Award-winning technical and business writer/editor, solid IT business analyst, and experienced project manager. Working knowledge of usability and accessibility,
Beitrag melden
Once you have your standards, templates, and style guide, make changes promptly and make sure everyone is aware of the changes. And don't leave old templates scattered around the ecosphere because people will find them, use them, and then waste time when they have to rework it all into the correct template. Delete them or archive them. This goes for logos, too. I was at a company once that had 6 versions of the same logo, going back years, but only one was the current one that could be used - and it was hard to tell which one it was.

Übersetzt

Gefällt mir

5 Überwachen und überprüfen

Schließlich müssen Sie Ihre Dokumentationsstandards und -vorlagen regelmäßig überwachen und überprüfen, um sicherzustellen, dass sie effektiv, relevant und auf dem neuesten Stand sind. Sie sollten Daten und Metriken zur Leistung, Qualität und Zufriedenheit Ihrer Dokumentationsprojekte sammeln und analysieren. Sie sollten auch Audits, Umfragen, Interviews oder Fokusgruppen durchführen, um Feedback und Meinungen von Ihrem Publikum, Team und Stakeholdern zu sammeln. Sie sollten sich auch über die neuesten Trends, Entwicklungen und Innovationen in Ihrer Branche, Ihrem Bereich und Ihrer Organisation informieren. Basierend auf Ihren Erkenntnissen sollten Sie bei Bedarf Verbesserungen oder Anpassungen an Ihren Dokumentationsstandards und -vorlagen vornehmen.

Fügen Sie Ihre Sichtweise hinzu

6 Hier ist, was Sie sonst noch beachten sollten

Dies ist ein Ort, an dem Sie Beispiele, Geschichten oder Erkenntnisse teilen können, die in keinen der vorherigen Abschnitte passen. Was möchten Sie noch hinzufügen?

Fügen Sie Ihre Sichtweise hinzu

Softwaredokumentation

+ Folgen

Diesen Artikel bewerten

Wir haben diesen Artikel mithilfe von KI erstellt. Wie finden Sie ihn?

Sehr gut Geht so

Diesen Artikel melden

Alle anzeigen

Wie erstellen und pflegen Sie Dokumentationsstandards und Vorlagen?

1

2

3

4

5

6

1 Identifizieren Sie Ihre Zielgruppe und Ziele

2 Recherche und Benchmarking

3 Erstellen und Dokumentieren

4 Kommunizieren und trainieren

5 Überwachen und überprüfen

6 Hier ist, was Sie sonst noch beachten sollten

Softwaredokumentation

Diesen Artikel bewerten

Vielen Dank für Ihr Feedback

Weitere Artikel zu Softwaredokumentation

Relevantere Lektüre