Vorlage für Projektbeschreibung: Unterschied zwischen den Versionen

Aus der Mikrocontroller.net Artikelsammlung, mit Beiträgen verschiedener Autoren (siehe Versionsgeschichte)
Wechseln zu: Navigation, Suche
K (typo)
 
(24 dazwischenliegende Versionen von 9 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
''von NAME''
''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|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 ==
== Einleitung ==


Hier steht eine Beschreibung des Projekts. Eine Beschreibung besteht aus dem Titel und einer Liste von Features.  
Beschreibung des Projekts als Fließtext und/oder Liste von Features.
 
Eine Liste von Features:


* Feature 1
* Feature 1
* Feature 2
* Feature 2
* 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 ==
Zeile 23: Zeile 20:


== Downloads ==
== Downloads ==
* Sourcecode: http://www.mikrocontroller.net/attachment.php/123/Sourcecode.zip
 
* Schaltplan: http://www.mikrocontroller.net/attachment.php/1234/Schaltplan.pdf
* [http://www.mikrocontroller.net/attachment.php/123/Sourcecode.zip Sourcecode]
* [http://www.mikrocontroller.net/attachment.php/1234/Schaltplan.pdf Schaltplan]


== Siehe auch ==
== Siehe auch ==
* [[Bebilderung|Bebilderung von Artikeln]]
* Diskussion zu diesem Projekt: http://www.mikrocontroller.net/forum/read-4-123.html
* Diskussion zu diesem Projekt: http://www.mikrocontroller.net/forum/read-4-123.html
* [[Audio-Projekt|Link zu anderem Projekt]]
* [[Audio-Projekt|Link zu anderem Projekt]]
Zeile 36: Zeile 36:
<!--  
<!--  
Bitte nicht blind die folgenden Kategorien kopieren ;-)
Bitte nicht blind die folgenden Kategorien kopieren ;-)
Beispiele:
[[Kategorie:AVR-Projekte]]
[[Kategorie:FPGA-Projekte]]
-->
-->



Aktuelle Version vom 18. Februar 2023, 16:52 Uhr

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.