DezeWikiInDetail/Software Documentatie

Deze pagina maakt deel uit van de serie DezeWikiInDetail.

Introductie

Dit artikel beschrijft alles wat met het documenteren van programmatuur te maken heeft.

Bijzonder aan deze beschrijvingen is, dat er de wens is voor zowel producten beschreven worden, die wel en die niet zijn opgenomen in het Software. In principe worden daarom de artikelen gerangschikt onder de Software paraplu. Dit vergemakkelijkt ook de uniforme artikelopbouw met behulp van templates als {{TNID Software}} → analoog aan {{TNID Host}}.

Dat laatste vergt tamelijk veel aanpassingen: Er is al heel wat beschreven ... (Zie ook PC Applicaties)

Verder is er een apart template voor {{APT packages}}. Meer hierover in APT/Documentatie.

Bedoeling

Elk stuk software, dat volgens de hier beschreven methodiek wordt vastgelegd, zal op identieke wijze worden beschreven.

Idee vorming

Om erin te komen schrijf ik uitwat zoal kan worden vastgelegd over software...

• Artikel waar alle verwijzingen naar software staan, eventueel gecategoriseerd. (Software ?)

• Per product een artikel met titels in de vorm 'ThuisNetInDetail/categorie/product'

  NB Er is al een aantal producten beschreven waarvan de basis niet aan deze normering voldoet!

Bij elk product bovenin een tabel met primaire gegevens als

• Productnaam
• Leverancier
• Categorie
• (recentste) versie

Basis Templates

{{TNID Software|id=Productnaam}}	{{TNID Software}} wordt gedefinieerd in het Artikel
	Functie: Genereert het basisartikel over de software, die in de id=parameter wordt genoemd.
{{TNID SoftwareTmpl|id=Productnaam}}	{{TNID SoftwareTmpl}} wordt gedefinieerd in de Discussie pagina van het artikel
	Functie: Genereert de serie tempaltes, die uiteindelijk het artikel samenstellen.
{{infobox software parameters}}|}	{{Infobox software}}
	Functie: definieert een tabel met daarin een reeks niet positionele parameters als volgt:

Zie ook

categorieen

Code templates

Versie templates

In detail

TNID Software

{{TNID Software}} genereert een serie aanroepen van de templates die gezamenlijk de diverse secties in het artikel bepalen. Met de parameter id= wordt de (unieke) naam genoemd van de software, die wordt beschreven.

TNID SoftwareTmpl

{{TNID SoftwareTmpl}} wordt gebruikt in de discusse pagina van het beschreven software onderdeel. Het genereert de aanroepverwijzing naar de in het artikel gebruikte templates.

Voorbeeld

	code	Genereert
	{{TNID SoftwareTmpl|id=voorbeeld}}	Codering Artikel gerichte templates {{TNID SW Doel voorbeeld}} Beschrijf de doelstelling voor het artikel {{TNID SW Geinstalleerd op voorbeeld}} Beschrijf waar de software werd geinstalleerd {{TNID SW Versies voorbeeld}} Versie beschrijvingen {{TNID SW Meer voorbeeld}} Meer over dit product. {{TNID SW Zie ook voorbeeld}} Zie ook {{TNID SW References voorbeeld}} Referenties Kijk ook op/in {{RecentVersion}} Voor de recente versie van voorbeeld ( Bulleted list item --> 12:27, 7 October 2024 (UTC) Dit is wiki OchaWiki ---- </noinclude>  RecentVersion: Fixed param1 (Productname) invalid or not set*). Algemene templates {{TNID Software}} Aanroep van het artikel {{TNID SoftwareTmpl}} Genereert deze tabel (Gebruik in Talk: pagina) Samengesteld met {{TNID SoftwareTmpl}} Codering Begin elk van de hierboven genoemde artikel templates met:   <noinclude> {{Retour Artikel|base=SW|id=voorbeeld}} = Edit dit template = </noinclude>

Wat codeer je

In de diverse templates worden de navolgende coderegels gehanteerd:

Codeer Doel

Begin met het introduceren van het {{Infobox Software}}.

Maak vervolgens een of meer alinea's waarin de doelstelling van de software wordt beschreven.

Codeer Geinstalleerd op

Tabel met hosts of websites, waar de software door ons werd geinstalleerd.

Voorbeeld:

codeer	Resultaat
{{tbl}} ! Host !! Versie !! Per datum |- | {{TNID2|LT0530}}1 | versie nr | ~~~~~ |- | {{TNID2|P2415}} | versie nr | Onbekend |}	Host Versie Per datum LT0530 versie nr 22:26, 13 October 2017 (CEST) P2415 versie nr Onbekend

Noot

1. Vanaf 17 januari 2019 is er hettemplate {{TNID Installed On}}

   {{TNID Installed On|id=KeePass|host=DT02}}

   Gebrik dat om een host te benoemen.

Codeer Versies

Een tabel met de 1e 2 niveaus van de versie nummers, gevolgd door de detail becscchrijvingen van de functionele onderwerpen per changelog.
Met behulp vam het Template:CurrentRelease wordt de versie aangeduid:

Codeer Meer

• Verwijzing naar de website van het product.
• Gedetaileerde beschrijving van het gebruik van de software.

Codeer Zie ook

Verwijzingen naar gerelateerde artikelen.

Itemgewijs opstellen, bij grote aantallen eventueel een tabel maken.

en afsluiten met

{{Referenties}} (indien gemaakt)

{{TNIDcat|Software|productnaam}}

Software op host

Een verbijzonderde vorm van software documentatie is het op uniforme wijze vastleggen van de gevolgen van de installatie van software op een host of website. Daarbij valt te denken aan

1. een apart template dat dient te worden gebruikt
   1. binnen de software documentatie

      en

   2. binnen de host c.q. wesite documentatie
2. de inhoud van zo'n (sub-)artikel.

X_SWHW

{{X_SWHW}} staat voor Cross Reference Soft- en hardware ...

Code	Resultaat
{{X_SWHW|sid=Thunderbird|hid=LT0530}}	Template:X SWHW
{{X_SWHW|sid=phpBB|wid=adjaan.nl}}	Template:X SWHW

Meerdere benaderingswijzen

In principe staan de software artikelen gedefinieerd als subartikel van Software. er doen zich in de wiki sitautties voor waarin dat niet het geval is. Dan wordt er veelal met een #REDIRECT door verwezen naar de beschrijving, zoals bovenbedoeld.

Voorbeeld:

[[Debian]] wijst deoo naar [[ThuisnetInDetail/Debian]]

Andersom komt ook voor (niet alleen voor software documentatie, maar voor alle Software artikelen:

Zie ook

• Template:TWID
• Software

  Daarin wordt verwezen naar {{TNID HostSoftware}}, wat bedoeld is om de voor een host geisntalleerde software weer te geven.

• {{RecentVersion}}

  Om een verwijzing naar de (meest recente) versie van een product te definireren of weer te geven...

• Productbeschrijvingen