Tech-Wiki:Contributing
More actions
Contributing to Tech-Wiki
Have something useful in your notes.txt? Share it.
Tech-Wiki is built around a simple idea: useful technical knowledge becomes more valuable when it is shared.
If you have a command, troubleshooting procedure, configuration example, technical fix or lesson that could save somebody else time, it may belong on Tech-Wiki.
What to contribute
Useful contributions might include:
- Troubleshooting procedures
- Commands and command examples
- Configuration examples
- Installation and administration guides
- Security configuration and hardening guidance
- Networking procedures
- Operating system administration
- Diagnostic techniques
- Technical reference information
- Solutions to unusual technical problems
- Lessons learned while solving a problem
A contribution does not need to be a large article.
A single useful command with a clear explanation can be just as valuable as a complete technical guide.
Before you contribute
Before publishing information, make sure it is suitable for a public website.
Examples and screenshots should be sanitised before being uploaded.
Remove or replace information such as:
- Usernames and email addresses
- Passwords
- API keys and access tokens
- Private cryptographic keys
- Internal hostnames
- Internal IP addresses
- Customer or company names
- Account, tenant or subscription identifiers
- Personally identifiable information
- Confidential URLs
- Other information specific to a private environment
Where necessary, replace real values with obvious examples such as:
server.example.com 192.0.2.10 [email protected] <username> <password> <server>
Writing a useful article
There is no requirement for every Tech-Wiki article to follow an identical structure.
Use the structure that best explains the subject.
Where appropriate, a useful technical article might include:
- A short description of what the article covers
- Prerequisites
- Commands or configuration examples
- An explanation of what the commands do
- Important warnings
- Useful tips
- Expected results
- Troubleshooting information
- Related articles
- Vendor documentation or other authoritative references
Commands and configuration
Commands should be clearly separated from normal article text.
Tech-Wiki provides the Command template for this purpose.
For example:
{{Command
|title=Check IP configuration
|1=ip addr show
}}
Where possible, briefly explain what the command does and what the reader should expect to see.
Do not assume that a reader understands the consequences of a potentially disruptive command.
Information, tips and warnings
Tech-Wiki provides several standard templates to keep articles consistent.
Use:
- Info for useful supporting information
- Tip for practical suggestions or shortcuts
- Warning where the reader should take particular care
- Prerequisites for requirements that should be met before starting
- TestedOn where a procedure has been verified against a particular product or version
Use these where they improve the article rather than adding them unnecessarily.
Tested versions
Technology changes quickly.
If you have personally verified a procedure against a particular product or software version, consider recording that using the TestedOn template.
For example:
{{TestedOn
|product=Example Product
|version=1.2.3
|date=September 2026
}}
Only state that something has been tested when it has actually been verified.
Older information can still be useful, but readers should be able to distinguish verified information from material that may require additional testing.
Screenshots
Screenshots can make technical instructions much easier to understand, but check them carefully before uploading.
Look for:
- Usernames
- Email addresses
- IP addresses
- Hostnames
- Tenant or account identifiers
- Browser bookmarks
- Notifications
- Customer information
- Credentials or tokens
- Other confidential information
Crop or redact sensitive information before uploading the image.
Accuracy and safety
Try to verify commands and procedures before publishing them.
If a command could cause disruption, data loss or a significant configuration change, explain the risk clearly.
Where appropriate, recommend:
- Taking a backup
- Recording the existing configuration
- Testing in a non-production environment
- Having a rollback procedure
- Consulting current vendor documentation
Do not present an untested assumption as a confirmed solution.
Vendor documentation and sources
Links to official vendor documentation are encouraged where they help readers verify information or learn more.
Do not copy large sections of vendor documentation into Tech-Wiki.
Summarise or explain the relevant information in your own words and link to the original source where appropriate.
Product names and trademarks remain the property of their respective owners.
Keep articles readable
Good technical documentation does not need to be complicated.
Prefer:
- Clear headings
- Short paragraphs
- Descriptive command titles
- Relevant examples
- Simple explanations
- Links to related Tech-Wiki articles
Avoid unnecessary formatting, excessive callouts or large amounts of duplicated information.
The objective is simple:
Help someone find the answer quickly.
Improving existing articles
Contributing does not always mean creating a new page.
Existing articles can be improved by:
- Correcting inaccurate information
- Clarifying instructions
- Adding missing steps
- Improving formatting
- Adding relevant examples
- Updating information for newer product versions
- Fixing broken links
- Adding useful references
- Linking related Tech-Wiki articles
Small improvements are welcome.
Need help?
If you are unsure whether something is appropriate for Tech-Wiki, or would like help contributing technical information, contact:
For more information about the project itself, see About Tech-Wiki.