- 11.1.4 Content Policies and Standards for Intranet Sites
- 22.214.171.124 Introduction
- 126.96.36.199 Other Intranet Policies
- 188.8.131.52 IRWeb the Default Home Page
- 184.108.40.206 Intranet Sites and Servers Must Be Registered
- 220.127.116.11 Intranet Sites Must Serve a Business Purpose
- 18.104.22.168 Intranet Content Must Be Appropriate
- 22.214.171.124 Only the Owner of Content May Post It to the Intranet
- 126.96.36.199 Search Engines Must Have a Limited Scope
- 188.8.131.52 Copyright Policy
- 184.108.40.206 Intranet Sites Must Be Accessible
- 220.127.116.11 Naming Convention
- 18.104.22.168 Proprietary Computer Code Must Be Approved Before Use
- 22.214.171.124 Use of Video/Audio on the Intranet
- 126.96.36.199 Additional Information
Part 11. Communications and Liaison
Chapter 1. Communications
Section 4. Content Policies and Standards for Intranet Sites
February 17, 2015
(1) This transmits revised IRM 11.1.4, Content Policies and Standards for Intranet Sites.
This manual outlines policies and standards for the establishment, design, and posting of content to IRS intranet sites.
(1) IRM 11.1.4 has been revised to incorporate new and update existing intranet standards. Sections have been reorganized and renumbered.
Office of Communications
This section outlines policies and standards for the establishment, design, and posting of content to IRS intranet sites. The officials normally responsible for an intranet site are its Executive Owner, Content Manager, and Web Administrator.
Other intranet-related policies, standards, and guidelines include:
Technical policy is at IRM 2.25, Managed Service for IRS
IRWeb ( http://irweb.irs.gov) is to be the default intranet home page for all employees. Managers who want their employees to make extensive use of a different site can have employees set up a "favorite" for that site in their web browser.
All IRS intranet sites and servers must be registered. To register a site or server, use the online registration system ( http://wspo.web.irs.gov/webreg/enter.asp) maintained by Information Technology's Enterprise Operations for Communications & Liaison (C&L). A site's Content Manager, the single person responsible for day-to-day management of the site, is typically the one who should complete the registration and maintain its accuracy. Most registered sites can be included in IRWeb's directory of intranet sites and in IRWeb’s Google search index.
A site is any Web page, including a subweb of any registered URL, that has its own home page and/or deviates from the official IRS intra-site consistency policy. All sites must secure their own registration.
Intra-Site Consistency Policy states a site and its subordinate pages should be consistent in appearance so that users know what site they are on, which organization owns it, and how the page fits within that site. Elements that should typically be repeated throughout a site include site branding, navigation, and contact information.
An important component of the site registration process is the naming of the site's Executive Owner who has ultimate responsibility for the site. The Executive Owner is to be an IRS executive or a senior manager. The embedded C&L office of applicant's division or function must approve the site. Divisions or functions without a C&L staff must have their sites approved and governed by Internal Communications within C&L.
At the conclusion of the online registration process, the system sends an email to the Executive Owner to request affirmation of responsibility for the site. The Executive affirmation confirms the site:
Contains only authorized data
Complies with mandatory system controls for Web Services
Will adhere to the standards prescribed for all IRS intranet sites
Sites or servers that are not properly registered will be removed from the intranet. Additionally, loss of site registration and intranet removal will occur when a site fails to adhere to the official IRS intranet standards. Internal C&L will alert the Executive Owner of any standards violation so that the owner can take prompt action to bring the site into compliance before it is removed from the system.
A site’s Executive Owner (IRS executive or senior manager appropriate for each site) is to certify that the site meets a test of business purpose. This policy was established in a July 1999 memorandum from the Chief C&L and was reaffirmed in a May 2003 memo from the Acting Deputy Commissioner for Modernization and CIO. Intranet sites with content that is frivolous or inconsistent with achieving the business of the IRS may be pulled from the intranet.
IRS executives certify the business purpose of intranet sites through the site registration process (all IRS intranet sites and servers must be registered). In this process, a site’s Content Manager must name the Executive Owner who is responsible for the site’s content. At the completion of the site registration process, the system sends an email to the Executive Owner to request affirmation of responsibility for the site.
To assist executives in making this decision, it is recommended that site owners prepare and keep on file a summary of the site, its business purpose, an identification of its audience and their needs, and a brief assessment of the cost to develop and maintain the site versus its expected benefit.
The content must be focused on the business of the IRS and must present a professional appearance that would reflect well on the IRS if it were to be viewed by anyone inside or outside of the IRS. Intranet pages must not provide links to Internet sites with inappropriate content, especially those categories of sites to which access is prohibited by the IRS policy on limited personal use of IRS resources. No taxpayer data will ever be published on the intranet.
A site's Executive Owner should be used as the arbiter of the appropriateness of the site's content.
Generally, you should not post or republish content that is owned by other IRS business units. (If you don’t own it, don’t post it.) This policy is important for several reasons: posting someone else’s content to your site could confuse employees about who owns the content, could mislead employees about where to get help, and — most damagingly — could give employees inaccurate information if the true IRS owner of the content ever changes it.
If you want to incorporate another business or functional unit's content into your site, the correct way to do so is by linking to it and/or by carefully summarizing it and providing attribution. If the information is not already available electronically, it can be posted with permission from the content owner with attribution.
Only IRWeb, the IRS intranet home page, may have a search feature with a scope that covers the entire intranet. The scope of search engines on other intranet sites or applications must be limited to the content of those particular sites.
Employees may not post or publish to an IRS intranet site any copyrighted material without the permission of the owner. If there is any reason to believe that text, images, or other materials may belong to someone else, do not copy or otherwise use it. Link to copyrighted material, do not copy. For more information about how to follow federal or other copyright laws, refer to:
IRM 188.8.131.52, Copyright and Copyrighted Material
Chief Counsel White Paper, "Copyright Law: When is Copying Fair?" ( http://ccintranet.prod.irscounsel.treas.gov/OrgStrat/Offices/GLS/Pages/Fair_Copying.aspx )
Guidance About Copyrights and Intranet Content ( http://irweb.irs.gov/AboutIRS/irhelp/intranet/standards_art/8847.aspx)
SPDER Guidance on How to Link to IRM ( http://irm.web.irs.gov/tools/createlink.asp)
Copying and Reposting Documents to Web Sites ( http://irweb.irs.gov/AboutIRS/irhelp/intranet/standards_art/8847.aspx )
IRS intranet sites and their content must be accessible. Federal and IRS policy requires it. The Information Resources Accessibility Program (IRAP) office in IT is responsible for setting IRS policy and standards for accessibility of intranet content. For more information about accessibility and Section 508 of the Rehabilitation Act, contact IRAP (http://irap.web.irs.gov/) or the Alternate Media Center ( http://amc.enterprise.irs.gov). Two key resources from these offices include IRAP's 508 Accessibility Checklists, and Web Services' Accessibility Standards.
The notice is available at http://irweb.irs.gov/AboutIRS/irhelp/privacy/default.aspx.
The following guidelines should be followed when naming files to post to the IRS intranet:
Make file names indicative of the file’s contents.
Do not use spaces or other non-alphanumeric characters, with the exception of the hyphen – or underscore _ to show delineation in file names.
Use of the hyphen is preferred over an underscore _ as hyphens increase readability for print.
Use standard file extensions (such as .pdf for Adobe Acrobat) Limit the length of file names as much as is logical.
Examples of good URLs created by following basic naming conventions mentioned above:
IRS Web developers do not use on IRS systems, any proprietary programming code, such as can often be found for free from Internet sites, unless it has been approved concerning issues of implied agreements, licenses, and security. This policy, codified at IRM 2.25.10, is based on IRS computer security policy and on a recent opinion provided by the office of Chief Counsel. This restriction does not apply to any code initiated and completed within the IRS, or by contractors under IRS direction, if the code was developed within the limits stated herein.
Legal Review — Chief Counsel has issued an opinion (GLS-110858-04, 4/19/04) urging IRS employees to avoid the use of proprietary code since its use may be interpreted as having been acquired for the benefit of the IRS and therefore may establish an unacceptable agreement to conditions stated or implied in the code or by its developer. Only IRS employees and contractors who have delegated authority to obligate the Service to such an agreement may do so. If, however, certain code is not copyrighted and there are no terms or conditions for its use, employees may use this code, subject to security approval. For example, there are many Internet sites that provide educational information on the use of code and may provide samples of code to reinforce concepts of code use.
Security Approval and Enterprise Architecture Policy — Notwithstanding the legal limitations and exceptions noted above, IRS security policy prohibits the use on IRS systems of any code that has not been specifically reviewed and approved for use on our systems by MITS, Information Technology Security Architecture & Engineering (ITSAE) Office within Enterprise Services (ES). There is also IRS Enterprise Architecture policy on the use of open source code that must be considered. Web or applications developers who wish to use any third-party code on IRS systems must contact MITS to begin the review and approval process.
The recommendations outlined below should not be construed as official standards; rather it is a conglomeration of industry best practices and is only provided as a starting point. The primary sources for these best practices are listed below. IT has not yet provided official guidance regarding IT limitations such as bandwidth and server capabilities. It is highly recommended that file sizes be limited to no more than 3-5 MB.
Considerations to Assist Your Decision — Using multimedia to deliver information over the intranet can be a very effective communication tool. Keep the following points in mind as you make your decision about creating multimedia content:
Not all employees may have computers with speakers
Some employees may have computers without the necessary technology or power to process a video
Risk of adding to the auditory clutter in areas where workstations are located in common spaces, i.e., cubicles
Employees are likely to tune in for a very short amount of time
All video projects must be reviewed by the Servicewide Video Editorial Board
Comply with Section 508 standards. Refer to IRAP (http://irap.web.irs.gov/). Is audio or video the best way to get your message across?
Limited Use Recommended — Until IT can provide clear technical parameters regarding the capabilities of the network and servers, the following limited use is recommended to deliver Corporate Messages:
Deliver by executives or directors
Length should be limited to about three minutes
Topic must be relevant to all employees
Limit frequency so the novelty doesn’t wear out
Production values should be high quality
Help the Users — The following tips are taken from the Nielson Norman Group Guidelines "Designing Usable Intranets – Communication"
Provide the following Information about the video:
Video’s length – write out the time like this – 5 minutes, and not like this – 5:00
Date of the video
Provide a transcript
Information about the presenter if the presenter is new or unknown to the audience
Warn users of potential technical issues and advise them of workarounds.
EXAMPLE: Due to the large size of the video, we recommend saving the file to your computer and viewing the video there. Directions to download: Right click on the link, select ‘Save Target As’.
Accessibility, Section 508. Be advised — official guidance on complying with section 508 must be obtained from the Information Resources Accessibility Program Office (http://irap.web.irs.gov/).
See Intranet Web Site Policies and Guidance ( http://irweb.irs.gov/AboutIRS/irhelp/intranet/default.aspx) for updated policies, references and additional resources.
For questions about this policy or to request an exception, please contact C&L Intranet Management Staff by sending an email to *CL Technology.