Administrative > Messages from the pfSense Team

Wiki Updates / Style Guidelines

(1/2) > >>

jimp:
Over the last few months I have worked through nearly every article in on our documentation wiki, https://doc.pfsense.org/ , editing for content, consistency, formatting, grammar, and so on.

Some articles have been updated for 2.2 (or at least 2.1.5), and some really old information was removed/cleaned up if it was no longer needed. A few things were rearranged, and some longer articles have been split up into smaller chunks. Quite a few new articles have also been added and there are more on the way.

Due to the large amount of work that has been put into cleaning up the Wiki and making corrections, the following is very important:

If you currently have an account to edit articles on the documentation wiki, please review the style and content guidelines before making any future edits to ensure that all articles continue to be of high quality and reflect well on the project.

Wiki Style Guide - https://doc.pfsense.org/index.php/Wiki_Style_Guide
Please read this entire article and follow the rules on the page. They are fairly simple guidelines but make a big difference in how articles look and read. Things like making sure "pfSense" is always properly capitalized, never addressing the user ("you", "your", etc.) and so on.

Quality Guidelines - https://doc.pfsense.org/index.php/Quality_guidelines
This article covers what should and should not be found in articles.

Templates - https://doc.pfsense.org/index.php/Template
Handy templates to add to articles to improve their appearance or make certain tasks easier.

Articles that do not follow the style and quality guidelines may be edited, removed, or flagged for cleanup.

If you notice an article that has a mistake or is in need of some other correction, bring it to our attention.

johnpoz:
Will take a look see, thanks!

biggsy:
Thanks, jimp. 

The style guide and templates are a great idea.

I did think a lot about which way to go regarding the use of the first and second person, etc.  There didn't seem to be much in the way of rules, so I just kept going in the hope of actually finishing my one and only contribution, while trying to figure out mediawiki formatting  ::).

I'll try to fix the screen shots (and maybe rework the first person stuff, as well)  in the very near future.

Edit: At least you didn't insist on pfSense®  :)

Derelict:
I've been trying to use them here, too.  I particularly like the italics for user entered content.  Beats using quotes.  (Do I enter the quotes or not?)

jimp:

--- Quote from: biggsy on January 21, 2015, 01:00:12 am ---The style guide and templates are a great idea.

--- End quote ---

The style guide is new but the templates have always been there (most of them, anyhow) -- funny thing though, even I had no idea that Templates page existed until I stumbled across it during this batch of updates :-)


--- Quote from: biggsy on January 21, 2015, 01:00:12 am ---I did think a lot about which way to go regarding the use of the first and second person, etc.  There didn't seem to be much in the way of rules, so I just kept going in the hope of actually finishing my one and only contribution, while trying to figure out mediawiki formatting  ::).

--- End quote ---

If you click "edit" on the style guide page the formatting is all there to see, which should be a handy reference for everyone to have in one spot.


--- Quote from: biggsy on January 21, 2015, 01:00:12 am ---I'll try to fix the screen shots (and maybe rework the first person stuff, as well)  in the very near future.

--- End quote ---

I fixed the wording/language on that page already, I think it just needs new screen shots to match the current wan=em0 lan=em1 recommendation.

Navigation

[0] Message Index

[#] Next page

Go to full version