Content Guidelines

General Guidelines

• Content must abide by the Atelier community rulesrules. as
  • They are posted in the Discord server and are also mirrored here.
• Content must be written in English, and must be as grammatically correct as possible.English.
  
• Content must be kept reasonably legible.
  • Please be as grammatically correct as possible - people will be reading the content for knowledge. 
  • Break apart excessively long sentences and paragraphs to make them easier to digest.
  • Make use of good organization, whether it be formatting, headers, or content ordering.
  • Don't go overboard with formatting - use the stock text size, font, color, and similarformatting formatting.aside from places where it's necessary to deviate.

Common Wiki Section

This is applicable to all wiki shelves not under the Original Content shelf.
This is also the group of pages for "traditional wiki-style" content that remains objective - for more informal and self-authored content, see the Original Content section below.

General Guidelines

• Keep content objective, third-party, and "wiki-style".
  • The style of writing should fit in with text out of a wiki, information resource, technical documentation, or encyclopedia.
  • Use of first-person speech, conversational forms, and pronouns are prohibited aside from as excerpts.
• ContentPlace mustbooks, notchapters, abuseand formatting.pages under reasonable organization.
  • LimitAvoid bold,duplication.
  italics,
  • Separate underlines,things textout colors,into highlights,chapters and similarpages formattingwhere applicable.
    As a general rule of thumb, if a reader would have trouble figuring out which citation is for which area of the page when looking at the citations section, it's time to onlyseparate wherethe applicablepage into smaller chunks.
    
  • An example of the rough scope of content is as follows:
    
    • Shelf: PCB Design
    • Book: Microcontrollers
    • Chapter: AVR Microcontrollers
    • Page: Atmega32u4
• Verify correctness of content as much as possible.
  
• Guides and beneficialtutorials may also be placed into the common wiki sections; however, they must be indisputably objective guides.
  • For example, a guide for installing KiCad or Git can be written into the common wiki. 
  • However, a guide on "how to design a keyboard PCB" or "how to design a case" is very author-specific, and should not be placed into the content.common wiki.
    Write these in the Original Content section instead.
  • When in doubt, ask in the Discord community's wiki channels.
• Don't conduct editing wars.
  • When there's a possible revision or conflict of information, use the Discord community's wiki channels to discuss solutions.
    
• SourcesCitations shouldare necessary. See below.

Citations

Due to the niche nature of keyboard design, there won't always be accessiblea third-party source to site.
To resolve this, the Atelier wiki allows for two types of sources: External Citations and meaningful.Internal References.

External Citations

• When possible, use external citations over internal references.
• Cite external sources in APA format at the end of each page. 
  Link to them inline via superscript 
• Pick meaningful sources of reasonable trustworthiness and applicability to the topic.
• 
  Avoid sources which are controversial, would lead to conflict, would endanger the reader if visited, or would otherwise go against the Atelier community rules and guidelines.

Internal References

• CiteWhen sourcesexternal citations are inapplicable or nonexistent, cite internal references.
• First write the content in APA format. All citations should be listed at the endOriginal of a page under aContent section headereddescribed "Citations" in largebelow, or mediumon headeryour size.own site/page.
  
Then,

Public Wiki Sections

This is applicablelink to all wiki shelves notthat under the User-AuthoredInternal Content shelf.

• Keep content objective, third-party, and "wiki-style".
  • The style of writing should fit along what would be expected out of a wiki, information resource, technical documentation, or encyclopedia.
  • Use of first-person speech and conversational forms is prohibited aside from as excerpts.
• When original works or research are involved, place the content first under your own User-Authored Content book or in your own articles elsewhere, then cite it as the reference.
• Place books, chapters, and pages under reasonable organization. Avoid duplication.
• Verify correctness of content as much as possible.
• Guides and tutorials may also be placed into the public wiki sections. 
  • These guides should be very unaffiliated in terms of designer, brand, or methodology; for very author-specific guides, please place them under the User-Authored ContentReferences section.
• If you are referencing an Atelier Discord community discussion, also list it under internal references.
  
• Please use the Discord to discuss regarding the content and possible edits when applicable.

User-Authored Content Section

This is applicable to the User-Authored Content shelf.

• Users are allocated one user-specific book upon request, in which they can write less wiki-like and more personal content.
  • For requesting a user book, please ping a wiki manager or ai03 in Discord.
• Types of content recommended for these sections are primary/original works and research, single-author guides and tutorials, development logs and stories, and similar content which are heavily user-bound and would not fit well within the structure of a typical wiki.
  
• Pages in this section may endorse specific designers, designs, brands, methodologies, and similar as long as they are of reasonable scope and applicable to the page.
• For general knowledge which would fit well within a wiki, please contribute to the public wiki sections instead.
• This section is not as rigid as the rest of the wiki in terms of tone, writing styles, or amount of error-checking done; for that reason, please copy-paste the following block onto the top of all pages under the User-Authored Content shelf.

User-Authored Content Disclaimer

This page is under the User-Authored Content section of the wiki.
Pages in this section are written primarily by a single author, and are less restricted than the general wiki.

• Pages in this section may include opinion- or methodology-based content.
• Pages in this section may include original research.
• Pages in this section may be subject to less error-checking.
  

Learn more