Vorlage für Projektbeschreibung: Unterschied zwischen den Versionen

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


Hier steht eine Beschreibung des Projekts.
Hier steht eine Beschreibung des Projekts. Eine Beschreibung besteht aus dem Titel und einer Liste von Features.  


Eine Liste von Features:
Eine Liste von Features:
Zeile 11: Zeile 11:
* Feature 3
* Feature 3


Es ist sinnvoll, dem Projekt einen vernünftigen Namen zu geben. Viele der Projekte und Artikel haben das 'AVR' als Anfang im Namen stehen. Das erscheint sinnvoll, ist es aber nicht, denn in der alphabetischen Sortierung stehen diese alle unter 'A'. Besser wäre es, einen Namen zu vergeben, der mit dem Zweck des Projektes übereinstimmt. Also:


Nicht 'AVR-Drehgeberdecoder'      sondern
'Gray-Code decoder für Drehgeber'
Bei Software, die nur auf dem AVR läuft, kann das 'AVR' als Suchtag verwendet werden. Falls die Software so geschrieben ist, dass sie auf mehreren verschiedenen CPUs läuft, soll keine CPU im Titel genannt werden.


== Software ==
== Software ==

Version vom 3. September 2009, 20:37 Uhr

von NAME

Einleitung

Hier steht eine Beschreibung des Projekts. Eine Beschreibung besteht aus dem Titel und einer Liste von Features.

Eine Liste von Features:

  • Feature 1
  • Feature 2
  • Feature 3

Es ist sinnvoll, dem Projekt einen vernünftigen Namen zu geben. Viele der Projekte und Artikel haben das 'AVR' als Anfang im Namen stehen. Das erscheint sinnvoll, ist es aber nicht, denn in der alphabetischen Sortierung stehen diese alle unter 'A'. Besser wäre es, einen Namen zu vergeben, der mit dem Zweck des Projektes übereinstimmt. Also:

Nicht 'AVR-Drehgeberdecoder' sondern 'Gray-Code decoder für Drehgeber'

Bei Software, die nur auf dem AVR läuft, kann das 'AVR' als Suchtag verwendet werden. Falls die Software so geschrieben ist, dass sie auf mehreren verschiedenen CPUs läuft, soll keine CPU im Titel genannt werden.

Software

Beschreibung der Software

Downloads

Siehe auch