Vorlage für Projektbeschreibung

Aus der Mikrocontroller.net Artikelsammlung, mit Beiträgen verschiedener Autoren (siehe Versionsgeschichte)
Wechseln zu: Navigation, Suche

von NAME

Es ist sinnvoll, dem Projekt einen aussagekräftigen Namen zu geben! Viele der Projekte und Artikel haben "AVR" als Anfang im Artikelnamen stehen. Das erscheint sinnvoll, ist es aber nicht, denn in der alphabetischen Sortierung stehen diese alle unter 'A'. Besser ist es, einen Namen zu vergeben, der mit dem Zweck des Projektes übereinstimmt. Also "Gray-Code Decoder für Drehgeber" anstatt "AVR-Drehgeberdecoder". Bei Software, die nur auf dem AVR läuft, kann das "AVR" als Suchtag verwendet werden oder man sortiert den Artikel in die Kategorie Kategorie:AVR-Projekte ein. Falls die Software so geschrieben ist, dass sie auf mehreren verschiedenen CPUs läuft, soll keine CPU im Titel genannt werden.

Hier steht eine kurze Beschreibung und ein Überblick über das Projekt. Wozu ist es gut, was macht es, etc.

Nach dieser Einleitung wird das automatisch erzeugte Inhaltsverzeichnis angezeigt.

Einleitung

Beschreibung des Projekts als Fließtext und/oder Liste von Features.

  • Feature 1
  • Feature 2
  • Feature 3

Software

Beschreibung der Software

Downloads

Siehe auch

Am Ende des Artikels erfolgt eine Einsortierung in Artikel-Schublade(n), auch Kategorie(n) genannt. Damit ist Dein Artikel leichter auffindbar.

Such aus den vorhandenen Kategorien diejenige(n) aus, die am besten auf den Artikel passen.