SME Contributor Manufacturing Knowledge Base Wiki Guidelines

Transcription

1 Identifier: SOP-FFC-TMEH- WC Revision: 2 Effective Date: 10/10/12 Document Catalog Number: 2011/10/01 Author: SME KDS Project Manager SME Contributor Manufacturing Knowledge Base Wiki Guidelines Memberhship One SME Drive P.O. Box 930 Dearborn, MI USA Ph: Website at

2 Dear SME Forming & Fabricating Colleague: Thank you for responding to our request for contributors, editors, and reviewers to the digital Manufacturing Knowledge Base wiki. At the core of this new digital platform is the world renowned 9-volume encyclopedic reference source, the Tool & Manufacturing Engineers Handbook (TMEH). These uniquely valued handbooks have been digitally transformed into the web-based resource that is now accessible online 24/7. SME is looking forward to your participation in this project as we engage our members to achieve our goal in supporting knowledge delivery. To assist you, we ve provided a contributor guideline. The intent is to create a uniform look and feel to the overall creation of the digital manufacturing knowledge base. All members can contribute new content or suggest changes to existing content; simply log into SME with user name and password for access. If you re interested in the role of Reviewer or Editor, please use the inquiry form process at or contact me at service@sme.org. These two roles are for super-users and vetted through the recruitment channel. The goal is to engage you to write contemporary updates of both content and format while efficiently utilizing your valuable time and knowledge. If you have previously written content, please consider how those articles maybe added with relatively little modifications or rewriting into the wiki. If you use material from other sources, please cite proper credit. The Copyright Permission Form enclosed should help you secure permission from other authors/sources. The SME copyright assignment is necessary to control reprinting without author/source permission. Thank you for consideration of time and expertise in this member engagement project. Sincerely, Charles Caristan, PhD F&F Community Advisor SME Manufacturing Knowledge Base Wiki International Fellow with Air Liquide charles.caristan@airliquide.com Natalie Lowell, CMfgT KDS Project Manager Membership Engagement Society of Manufacturing Engineers nlowell@sme.org Document: SME_FFC_Contributor 10/10/2012 Page 2 of 7

3 1. Volunteer Contributor Description 1.1 Purpose This document describes the process for contributing to the digital Manufacturing Knowledge Base. SME members and subject matter experts will create an SME Wiki site. The foundation of the wiki is content contained in the Tool and Manufacturing Engineers Handbook (TMEH) series. SME is expanding the growth of its Technical Communities and local member units by enabling members and subject matter experts to engage, develop, and share new content in the peer-reviewed wiki. 1.2 Scope Members, subject matter experts, staff and contractors when engaging in the SME Manufacturing Knowledge Base wiki project shall adhere to this standard operating guideline. 1.3 Training The SME staff and key volunteers are responsible for ensuring that team members follow this guideline and understand the objectives and inter-related activities. Training aids are available on the website and available upon request. Advanced users training will be provided to members or subject matter experts in super-user roles such as Router, Reviewer, or Editor. 1.4 Volunteer Objectives Posts new content based on industry growth Suggests edits to existing content Willing to post full name and credentials to the public as the content contributor Direct experience working in and/or researching the technical area of wiki entry Willing to have work reviewed, edited, and verified by other subject matter experts Willing to collaborate with other subject matter experts on content creation Factual in all contributions and reflect best practices Follow SME submission guidelines Reference all content submissions to source material Minimum time is completion of specified wiki article assignment Document: SME_FFC_Contributor 10/10/2012 Page 3 of 7

4 1.5 SME Wiki Content Work Flow 1.6 Credentials Contributors shall be subject matter experts within the focus area of their profession Contributors shall provide a brief biography detailing subject matter expertise/experience in their member profile including: o o Professional credentials SME membership involvement SME member contributors are members in good standing Non-members may contribute to the wiki on an invitation-only basis. Members may recommend non-member to the appropriate SME staff by ing service@sme.org Document: SME_FFC_Contributor 10/10/2012 Page 4 of 7

5 2. Contributor Guidelines To ensure uniform structure and flow of the wiki, the contributor shall adhere to these guidelines. Contributors are responsible and should understand this procedure before performing the following tasks. Contact SME Customer Care if you have any questions about this procedure. 2.1 Materials Materials must be the original work of the contributor. Contributions must remain on topic. If the topic is broad, consider breaking the topic into two or more wiki entries or create an entirely new topic as needed. All factual information and common methods, processes, and practices should be the focus of your contribution; avoid personal opinion on a topic as this may be unique to your situation and not a reflection of common practice. Writing must conform to American English language spelling and grammar rules. Metric conversion (in parentheses) should accompany U.S. measures where appropriate. Trademarks must be properly cited and shown. Content must be complete, accurate, and comply with current standards, to the best of your knowledge. Any material deemed libelous, obscene, proprietary, infringing on the rights of others, or unlawful, will be removed and appropriate measures will be taken to censure the contributor up to a full revocation of contributor rights. All topics must be tagged with appropriate taxonomy. ALL material must be referenced/sourced, following the Chicago Manual of Style reference citation standards. If you wish to use material directly from another publication, you must first acquire content permission for usage from the original publisher of the material for both electronic and print use of the material (photos, text, etc.). You may provide the publisher with the Copyright Permission Form contained in this procedure and obtain the required information with signature and submitted to SME at publications@sme.org. All uploaded images must contain a caption detailing both the source document and acknowledgement of permission by the copyright holder. All text must contain reference to original material at place where cited, with accompanying bibliographic reference at the end of the topic. Hyperlinks: you may insert links to other reference sources/materials. All links must be valid and verified. Document: SME_FFC_Contributor 10/10/2012 Page 5 of 7

6 2.2 Image/Graphics Format Graphics fall into several categories: line art, charts/graphs, photographs, illustrations, tables, etc. Acceptable image/graphics shall be in one of the following: 100 dpi PNG for screen resolution (RGB color model) 600 dpi PNG for line art (black and white) 300 dpi PNG for grayscale or color (CMYK color model) Image resolution must be true to the size at which the graphic will be displayed online or within an 8-1/2 x 11 page. JPG images are also acceptable, saved at these same resolutions. Saving a high and a low resolution version is a requirement of our content management system and will ensure the greatest versatility in content use. SVG files are also acceptable, but PNG or JPG versions would also need to be saved. Other formats maybe acceptable from the standard Microsoft Office set of programs (Word, Excel, PowerPoint). You may insert graphic files directly into the wiki entry. You must caption each graphic or table file. Numbering within the entry should agree for each type of file, for instance, Table 1, Table 2, etc., Figure 1, Figure 2, Equation 1, Equation 2, etc. Caption should describe what the graphic or table is depicting and align with the textual citation. Caption should include a reference if it came from another source with permission to use. If you wish to use material directly from another publication, you must first acquire content permission usage from the original publisher of the material for both electronic and print use of the material. You may provide the publisher with the Copyright Permission Form contained in this procedure and obtain the required information with signature and submitted to SME at publications@sme.org Line art files: Keep the use of cross hatches and fills to a minimum. Though they render well on screen, they do not always print well. Do not use hairline rule widths; we recommend using a rule of no less than.5 point (0.007 in.) and no larger than 2 points. Use of color: for all graphics, the use of color is encouraged within the wiki. Please note that color graphics may not, however, print well. Please consider both web and print viewing of the graphic when deciding between color and grayscale graphics. Document: SME_FFC_Contributor 10/10/2012 Page 6 of 7

7 2.3 Math Equations Math equations may be inserted using the MathML function within the wiki OR they may be inserted as a graphic file using the standards above, providing screen and high resolution versions. 2.4 Other Images Contributors may want to insert excel files, tables, charts, graphs, or other images created using desktop business software. All images must be saved as.jpg format for inclusion in the wiki environment. PDF file formats should help us here with CAD/CAM file formats. Some generic CAD file formats used in engineering file works: DXF, IGES, STEP, STL, XYZ, DWG, ACIS, SVG, etc. If these software systems can export drawings to a PDF file, then SME should be able to upload into the system. 2.5 Other Files Contributors may want to upload or attach a file for use by others. For example: Someone developed a specialized calculator in Excel and wants to share it with others in the wiki. You may upload files that are from the standard Microsoft Office set of programs (Word, Excel, Powerpoint). Please contact SME at publications@sme.org to inquire about other file types/formats. 2.6 SME Procedures Contributors to the SME Manufacturing Knowledge Base wiki shall abide by the operating principles of the Constitution and Bylaws for the Society of Manufacturing Engineers. In particular, the following areas shall be adhered to in working on the society initiatives such as the manufacturing knowledge base wiki. SME Leadership Code of Conduct Code of Ethics Cannons of Professional Conduct Document: SME_FFC_Contributor 10/10/2012 Page 7 of 7

8 From: Permission Requestor Address, City, State, zip code Contact information (telephone, fax, , etc.) To: Copyright Permission Manager Address, City, State, zip code Contact information (telephone, fax, , etc,) Dear Sir/Madam: I request permission to use the following material in a wiki entry on the Society of Manufacturing Engineers (SME) website in relation to the topic By signing below, you hereby grant SME permission to use the material in print, electronic, subscriptions, and derivative editions throughout the world and in any language. This includes the right to reproduce, visually display, and digitally archive and serve the material in any form to create unique products such as e-books, e-content services and subscriptions, electronic applications with enhancements, and other custom products. The permission granted is for the life of the particular products. Source: Material: Acknowledgement of your materials will be made at the point of use. Please provide specific copy if you require a custom citation/credit line/courtesy line: We greatly appreciate your thoughtfulness and your timely response to this request. Sincerely, Approval Signed: Publisher or Company Name: Date: Document: Copyright Permission Form 10/9/2012