Guideline Structure - Revision history

Suraj.mali@heinfricke.team at 11:11, 1 December 2025

2025-12-01T11:11:06Z

← Older revision		Revision as of 11:11, 1 December 2025
Line 2:		Line 2:

	== Problem ==		== Problem ==
	Wikipedia and other MediaWiki-based wikis do not have a true folder or hierarchical page structure.		Wikipedia and other MediaWiki-based wikis do not have a true folder or hierarchical page structure. All pages exist in a flat namespace.
	All pages exist in a flat namespace.

	== Goal ==		== Goal ==
	Create a logical hierarchy using ~~'''~~normal pages that contain structured lists of links~~'''~~.		Create a logical hierarchy using normal pages that contain structured lists of links. This approach makes the wiki ''feel'' hierarchical without changing its underlying technical structure.
	This approach makes the wiki feel hierarchical without changing its technical structure.

	----		----

	== Step 1: Create a “Parent” Page ==		== Step 1: Create a “Parent” Page ==
	Create a main page that ~~acts~~ as a directory or table of contents for a topic.		Create a main page that serves as a directory or table of contents for a topic.

	'''Example:'''		'''Example:'''
Line 25:		Line 23:

	== Developer Teams ==		== Developer Teams ==
	* [[HF_ALL/Developers/TeamBornemann]]		* [[HF_ALL/Developers/TeamBornemann]]* [[HF_ALL/Developers/TeamOdoo]]* [[HF_ALL/Developers/TeamNordex]]* [[HF_ALL/Developers/TeamMercedes]]
	* [[HF_ALL/Developers/TeamOdoo]]
	* [[HF_ALL/Developers/TeamNordex]]
	* [[HF_ALL/Developers/TeamMercedes]]

	== General Documentation ==		== General Documentation ==
	* [[HF_ALL/Developers/Onboarding]]		* [[HF_ALL/Developers/Onboarding]]* [[HF_ALL/Developers/CodeStandards]]* [[HF_ALL/Developers/DevTools]]* [[HF_ALL/Developers/BestPractices]][[HF_ALL\|← Back to HF_ALL]]
	* [[HF_ALL/Developers/CodeStandards]]
	* [[HF_ALL/Developers/DevTools]]
	* [[HF_ALL/Developers/BestPractices]]

	[[HF_ALL\|← Back to HF_ALL]]

	</pre>		</pre>

Line 43:		Line 31:

	== Step 2: Create the Linked Pages ==		== Step 2: Create the Linked Pages ==
	Click a red link (for example ~~HF ALL:~~Developers/~~Nordex~~ to create that subpage.		Click a red link (for example <code>HF_ALL/Developers/TeamBornemann</code>) to create that subpage.

	'''Example:'''		'''Example:'''
	; Page title		; Page title
	: <code>Developers/~~Team Bornemann~~</code>		: <code>Developers/TeamBornemann</code>

	; Page content		; Page content
	<pre>		<pre>
	= Team Bornemann =		= Team Bornemann =
	Project Team Bornemann		Documentation related to Project Team Bornemann.
			[[Developers\|← Back to Developers]]
	[[~~Devolopers~~\|← Back to Developers]]
	</pre>		</pre>

	~~Each page links back to its parent using~~:		Use the format:
	<pre>[[ParentPageName\|← Back to Parent Page]]</pre>		<pre>[[ParentPageName\|← Back to Parent Page]] </pre>

	----		----
Line 67:		Line 54:
	'''Example:'''		'''Example:'''
	; Page title		; Page title
	: <code>Developers/~~Team Bornemann~~/Planning</code>		: <code>Developers/TeamBornemann/Planning</code>

	; Page content		; Page content
Line 73:		Line 60:
	= Team Bornemann – Planning =		= Team Bornemann – Planning =
	Details of the planning phase.		Details of the planning phase.
			[[Developers/TeamBornemann\|← Back to Team Bornemann]]
	[[Developers/~~Team Bornemann~~\|← Back to Team Bornemann]]
	</pre>		</pre>

Line 80:		Line 66:

	== Step 4: (Optional) Create an Overview or “Tree” ==		== Step 4: (Optional) Create an Overview or “Tree” ==
	You can manually ~~display a~~ hierarchy ~~by nesting~~ lists:		You can manually show the hierarchy using nested bullet lists.

	<pre>		<pre>
Line 86:		Line 72:

	== Teams ==		== Teams ==
	* [[HF_ALL/Developers/TeamBornemann]]		* [[HF_ALL/Developers/TeamBornemann]]* [[HF_ALL/Developers/TeamOdoo]]* [[HF_ALL/Developers/TeamNordex]]* [[HF_ALL/Developers/TeamMercedes]]
	* [[HF_ALL/Developers/TeamOdoo]]
	* [[HF_ALL/Developers/TeamNordex]]
	* [[HF_ALL/Developers/TeamMercedes]]

	== Documentation ==		== Documentation ==
	* [[HF_ALL/Developers/Onboarding]]		* [[HF_ALL/Developers/Onboarding]]* [[HF_ALL/Developers/CodeStandards]] [[HF_ALL/Developers/CodeStandards/Python]] [[HF_ALL/Developers/CodeStandards/JavaScript]]
	* [[HF_ALL/Developers/CodeStandards]]		* [[HF_ALL/Developers/DevTools]] [[HF_ALL/Developers/DevTools/Git]] [[HF_ALL/Developers/DevTools/VSCode]]
	** [[HF_ALL/Developers/CodeStandards/Python]]
	** [[HF_ALL/Developers/CodeStandards/JavaScript]]

	* [[HF_ALL/Developers/DevTools]]
	** [[HF_ALL/Developers/DevTools/Git]]
	** [[HF_ALL/Developers/DevTools/VSCode]]
	</pre>		</pre>

	This ~~structure~~ visually represents a hierarchy even though the wiki ~~pages are~~ flat.		This visually represents a hierarchy even though the wiki itself is flat.

	----		----

	== Tips ==		== Tips ==
	* Use consistent page names with slashes, ~~such as~~ <code>Developers/~~Team Bornemann~~/Planning</code>.
	* Add a ~~“Back~~ to ~~parent”~~ link on each subpage.		* Use consistent page names with slashes (e.g., <code>Developers/TeamBornemann/Planning</code>).
	* ~~You can create~~ a ~~small~~ template to simplify ~~the~~ “Back” ~~link~~, ~~for example~~:		* Add a "Back to parent" link on each subpage.
	~~<pre>{{HF_ALL\|Developers/Team Bornemann}}</pre>~~		* Consider creating a template to simplify “Back” links, e.g.:
	* Maintain a single “index” page (~~like~~ <code>Developers</code>) that defines the hierarchy.		* Maintain a single “index” page (e.g., <code>HF_ALL/Developers</code>) that defines the hierarchy.
			* Store only internal documentation—avoid client-confidential content.

	----		----

	== Summary ==		== Summary ==

			To create a clean, structured hierarchy in MediaWiki under <code>HF_ALL</code>:

			* Create a department index page (e.g., <code>HF_ALL/Developers</code>)
			* Add subpages using <code>/</code>
			* Add back-links on each subpage
			* Build a tree-like structure using bullet lists
			* Maintain consistent naming across all pages

			This creates a predictable, professional, and easy-to-navigate documentation system for all teams.

			<code><nowiki>{HF_ALL\|Developers/TeamBornemann}}</nowiki></code>
	{\| class="wikitable"		{\| class="wikitable"
	To create a clean, structured hierarchy in MediaWiki under '''HF_ALL''':		To create a clean, structured hierarchy in MediaWiki under '''HF_ALL''':

Swapnil.mangalkar@heinfricke.team at 10:29, 1 December 2025

2025-12-01T10:29:02Z

Show changes

Swapnil.mangalkar@heinfricke.team at 10:22, 1 December 2025

2025-12-01T10:22:20Z

Show changes

Swapnil.mangalkar@heinfricke.team at 10:17, 1 December 2025

2025-12-01T10:17:44Z

← Older revision		Revision as of 10:17, 1 December 2025
Line 16:		Line 16:
	'''Example:'''		'''Example:'''
	; Page title		; Page title
			;
	: <code>Developers</code>		: <code>Developers</code>
	[[File:S3.png\|frame\|border\|none]]		[[File:S3.png\|frame\|border\|none]]

Swapnil.mangalkar@heinfricke.team at 10:17, 1 December 2025

2025-12-01T10:17:08Z

← Older revision		Revision as of 10:17, 1 December 2025
Line 117:		Line 117:
	== Summary ==		== Summary ==
	{\| class="wikitable"		{\| class="wikitable"
			To create a clean, structured hierarchy in MediaWiki under '''HF_ALL''':

			# Create a '''department index page''' (e.g., HF_ALL/Developers)
			# Add subpages using <code>/</code>
			# Include back-links on every subpage
			# Build a tree-like structure using bullet lists
			# Keep only '''general internal documentation''' (no client-confidential info)

			This creates a predictable, professional, and easy-to-navigate documentation system for all teams.

Swapnil.mangalkar@heinfricke.team at 10:16, 1 December 2025

2025-12-01T10:16:38Z

← Older revision		Revision as of 10:16, 1 December 2025
Line 110:		Line 110:
	* Add a “Back to parent” link on each subpage.		* Add a “Back to parent” link on each subpage.
	* You can create a small template to simplify the “Back” link, for example:		* You can create a small template to simplify the “Back” link, for example:
	<pre>{{~~Parent~~\|~~Projects~~/~~ProjectA~~}}</pre>		<pre>{{HF_ALL\|Developers/Team Bornemann}}</pre>
	* Maintain a single “index” page (like <code>Developers</code>) that defines the hierarchy.		* Maintain a single “index” page (like <code>Developers</code>) that defines the hierarchy.

Swapnil.mangalkar@heinfricke.team at 10:15, 1 December 2025

2025-12-01T10:15:59Z

← Older revision		Revision as of 10:15, 1 December 2025
Line 111:		Line 111:
	* You can create a small template to simplify the “Back” link, for example:		* You can create a small template to simplify the “Back” link, for example:
	<pre>{{Parent\|Projects/ProjectA}}</pre>		<pre>{{Parent\|Projects/ProjectA}}</pre>
	* Maintain a single “index” page (like <code>~~Projects~~</code>) that defines the hierarchy.		* Maintain a single “index” page (like <code>Developers</code>) that defines the hierarchy.

	----		----

Swapnil.mangalkar@heinfricke.team at 10:15, 1 December 2025

2025-12-01T10:15:30Z

← Older revision		Revision as of 10:15, 1 December 2025
Line 51:		Line 51:
	; Page content		; Page content
	<pre>		<pre>
	= ~~Project A~~ =		= Team Bornemann =
	~~This is~~ Project A.		Project Team Bornemann

	[[~~Projects~~\|← Back to ~~Projects~~]]		[[Devolopers\|← Back to Developers]]
	</pre>		</pre>

Line 67:		Line 67:
	'''Example:'''		'''Example:'''
	; Page title		; Page title
	: <code>~~Projects~~/~~Project A~~/Planning</code>		: <code>Developers/Team Bornemann/Planning</code>

	; Page content		; Page content
	<pre>		<pre>
	= ~~Project A~~ – Planning =		= Team Bornemann – Planning =
	Details of the planning phase.		Details of the planning phase.

	[[~~Projects~~/~~Project A~~\|← Back to ~~Project A~~]]		[[Developers/Team Bornemann\|← Back to Team Bornemann]]
	</pre>		</pre>

Line 83:		Line 83:

	<pre>		<pre>
	= ~~Projects~~ =		= Developers =
	* [[~~Projects~~/~~Project A~~]]
	** [[~~Projects~~/~~Project A~~/~~Planning~~]]		== Teams ==
	** [[~~Projects~~/~~Project A~~/~~Results~~]]		* [[HF_ALL/Developers/TeamBornemann]]
	* [[~~Projects~~/~~Project B~~]]		* [[HF_ALL/Developers/TeamOdoo]]
	** [[~~Projects~~/~~Project B~~/~~Planning~~]]		* [[HF_ALL/Developers/TeamNordex]]
	** [[~~Projects~~/~~Project B~~/~~Results~~]]		* [[HF_ALL/Developers/TeamMercedes]]

			== Documentation ==
			* [[HF_ALL/Developers/Onboarding]]
			* [[HF_ALL/Developers/CodeStandards]]
			** [[HF_ALL/Developers/CodeStandards/Python]]
			** [[HF_ALL/Developers/CodeStandards/JavaScript]]

			* [[HF_ALL/Developers/DevTools]]
			** [[HF_ALL/Developers/DevTools/Git]]
			** [[HF_ALL/Developers/DevTools/VSCode]]
	</pre>		</pre>

Line 97:		Line 107:

	== Tips ==		== Tips ==
	* Use consistent page names with slashes, such as <code>~~Projects~~/~~ProjectA~~/Planning</code>.		* Use consistent page names with slashes, such as <code>Developers/Team Bornemann/Planning</code>.
	* Add a “Back to parent” link on each subpage.		* Add a “Back to parent” link on each subpage.
	* You can create a small template to simplify the “Back” link, for example:		* You can create a small template to simplify the “Back” link, for example:

Swapnil.mangalkar@heinfricke.team at 10:09, 1 December 2025

2025-12-01T10:09:17Z

← Older revision		Revision as of 10:09, 1 December 2025
Line 47:		Line 47:
	'''Example:'''		'''Example:'''
	; Page title		; Page title
	: <code>Developers/~~Project A~~</code>		: <code>Developers/Team Bornemann</code>

	; Page content		; Page content

Swapnil.mangalkar@heinfricke.team: /* Step 2: Create the Linked Pages */

2025-12-01T10:08:39Z

Step 2: Create the Linked Pages

← Older revision		Revision as of 10:08, 1 December 2025
Line 47:		Line 47:
	'''Example:'''		'''Example:'''
	; Page title		; Page title
	: <code>~~Projects~~/Project A</code>		: <code>Developers/Project A</code>

	; Page content		; Page content