Category:Reference: Difference between revisions

(5 intermediate revisions by 2 users not shown)

Line 1:

''Reference'' is one of the five primary [[Resources|resource]] categories for the wiki.

Reference guides are technical descriptions of the machinery and how to operate it.

Line 11:

Line 13:

Normally Reference guides have no place in the wiki as they should be part of the project documentation itself. Under very special circumstances it might be the case that Reference Documentation is stored as an wiki article for a short time e.g. upstream project currently has no place for said documentation or the first draft for a reference document will be written here before being transferred.

Content of this category should be moved to the manuals or https://nix.dev

* [https://nixos.org/nixos/manual/ NixOS manual]

* [https://nixos.org/nix/manual/ Nix manual]

* [https://nixos.org/nixpkgs/manual/ Nixpkgs manual]

* [https://nixos.org/hydra/manual/ Hydra manual]

== Comparison to other resource page types ==

* If information is more encyclopedic (with a similar scope and tone to pages on [https://www.wikipedia.org/ Wikipedia]), a page would be considered a [[:Category:Pedias|pedia]].

* If information is less encyclopedic and more similar to a [https://en.wikipedia.org/wiki/Compendium compendium], [https://en.wikipedia.org/wiki/Study_guide study guide], or a [https://en.wikipedia.org/wiki/Guide_to_information_sources bibliographic guide], a page would be considered a [[:Category:Guide|guide]].

* If information is more about direct instruction to achieve a specific task, a page would be considered a [[:Category:Tutorial|tutorial]].

* If a page is more just a set of tips and tricks (less instructive than a tutorial), it would be a [[:Category:Cookbook|cookbook]].

* If a page is a detailed reference (like a man page or full software manual), it would fit under [[:Category:reference|references]].

[[Category:Resource]]

@@ Line 1: / Line 1: @@
+''Reference'' is one of the five primary [[Resources|resource]] categories for the wiki.
 Reference guides are technical descriptions of the machinery and how to operate it.
@@ Line 11: / Line 13: @@
 Normally Reference guides have no place in the wiki as they should be part of the project documentation itself. Under very special circumstances it might be the case that Reference Documentation is stored as an wiki article for a short time e.g. upstream project currently has no place for said documentation or the first draft for a reference document will be written here before being transferred.
+Content of this category should be moved to the manuals or https://nix.dev
+* [https://nixos.org/nixos/manual/ NixOS manual]
+* [https://nixos.org/nix/manual/ Nix manual]
+* [https://nixos.org/nixpkgs/manual/ Nixpkgs manual]
+* [https://nixos.org/hydra/manual/ Hydra manual]
+== Comparison to other resource page types ==
+* If information is more encyclopedic (with a similar scope and tone to pages on [https://www.wikipedia.org/ Wikipedia]), a page would be considered a [[:Category:Pedias|pedia]].
+* If information is less encyclopedic and more similar to a [https://en.wikipedia.org/wiki/Compendium compendium], [https://en.wikipedia.org/wiki/Study_guide study guide], or a [https://en.wikipedia.org/wiki/Guide_to_information_sources bibliographic guide], a page would be considered a [[:Category:Guide|guide]].
+* If information is more about direct instruction to achieve a specific task, a page would be considered a [[:Category:Tutorial|tutorial]].
+* If a page is more just a set of tips and tricks (less instructive than a tutorial), it would be a [[:Category:Cookbook|cookbook]].
+* If a page is a detailed reference (like a man page or full software manual), it would fit under [[:Category:reference|references]].
+[[Category:Resource]]