Manual Transmittal
December 14, 2012
Purpose
(1) This transmits revised IRM 1.11.7, Internal Management Documents System, Accounts Management Tax/Policy/Program Analyst Guide.
Material Changes
(1) The following subsections have been deleted because the information can be found in other IRMs and/or IMD resources and/or the procedures are no longer applicable.
-
IRM 1.11.7.1.1, Erroneous Taxpayer Correspondence (information can be found in IRM 25.13.1.3, Erroneous Correspondence Procedures - Red Button Process)
-
IRM 1.11.7.1.2, IRM Writing Template Format (procedures are no longer being used)
-
IRM 1.11.7.2.2 , IRM Review of Quarterly of Quarterly/Yearly Printed Updates by Chief Counsel (information can be found in IRM 1.11.9.4.1, Chief Counsel)
-
IRM 1.11.7.4, IRM Writing Clarification/Change Requests (information can be found in IRM 1.11.8.10, SERP Feedback Application– Author/Content Owner Responsibilities; IRM 1.11.9.10, Guidelines for Reviewers; IRM 1.11.9.11, Responding to Reviewer’s Comments; and IRM 21.1.2.2.2, IRM 21 – Change Requests)
-
IRM 1.11.7.5, IRM Job Aids (information can be found in IRM 1.11.8.6.5, Adding Job Aids)
-
IRM 1.11.7.6, Using Intranet Web Addresses in the IRM (information can be found in IRM 1.11.2.8.3.5, Citing Website Sources and Creating Links)
-
IRM 1.11.7.7, When to Use Intranet Web Addresses in the IRM (information can be found in IRM 1.11.2.8.3.5, Citing Website Sources and Creating Links)
-
IRM 1.11.7.8, IRM Author Training (information can be found at http://spder.web.irs.gov/imd/training/.
-
IRM 1.11.7.8.1, SERP Alerts with Disaster Criteria (information can be found in IRM 1.11.8.6.2.1, SERP Alerts with Disaster Criteria)
-
IRM 1.11.7.8.2, Editorial Updates (information can be found in IRM 1.11.2.13, Making Minor Changes to an IRM Section: Editorial Updates)
(2) This IRM has been restructured to combine related subsections and group similar topics, clarify guidance, and improve reading flow; this resulted in some subsections being renumbered and retitled.
(3) Editorial changes have been made throughout the text.
(4) IRM 1.11.7.1, Overview of Accounts Management (AM) Internal Management Document (IMD) Program for IRM Coordinators/Authors and Analysts, changed subsection titled and revised content to update reference tools and clarify that AM IRM authors should use these reference tools.
(5) IRM 1.11.7.1.1, AM IMD Program Roles and Responsibilities, added new subsection to introduce section on roles and responsibilities.
(6) IRM 1.11.7.1.1.1, AM Tax/Policy/Program Analyst Roles and Responsibilities, added new subsection on AM tax/policy/program analyst roles and responsibilities, includes information on IRS.gov updates, training material updates, employee suggestions.
(7) IRM 1.11.7.1.1.2, AM IRM Coordinator Roles and Responsibilities, added new subsection on AM IRM Coordinator roles and responsibilities.
(8) IRM 1.11.7.1.1.3, AM IRM Author Roles and Responsibilities, changed subsection titled and revised content.
(9) IRM 1.11.7.2, IRM Process, added new subsection to introduce the IRM Process section.
(10) IRM 1.11.7.2.1, Authoring the IRM, changed subsection titled and revised content.
(11) IRM 1.11.7.2.1.1, Manual Transmittal, added new subsection to cover Manual Transmittal when authoring an IRM in general.
(12) IRM 1.11.7.2.1.2, Subsection/Exhibit Dates, changed subsection titled and revised content to include procedures on when subsections dates should be changed relating to issuance of Internal Procedural Updates (IPUs).
(13) IRM 1.11.7.2.1.3, References to IRMs, Legal Sources, Court Cases, Websites and Other IRS Published Products, changed subsection titled and revised content to add references other than IRMs.
(14) IRM 1.11.7.2.1.4, Official Use Only (OUO), added new subsection to cover information of OUO materials in IRM.
(15) IRM 1.11.7.2.1.5, Clearing IRMs, added new subsection to cover general information on the clearance process.
(16) IRM 1.11.7.2.1.6, Obtaining Approval to Publish IRM, added new subsection to cover general information for publishing an IRM.
(17) IRM 1.11.7.2.1.7, Completing Final Review and Uploading the IRM for Publishing, added new subsection to explain the uploading process.
(18) IRM 1.11.7.2.2, Addressing IRM Feedback and Comments, added new subsection to cover SERP Alerts and SERP Feedback.
(19) IRM 1.11.7.2.3, Updating the IRM Between Publishing, added new subsection to cover general information on updating IRMs and to introduce the section on updating the IRM.
(20) IRM 1.11.7.2.3.1, Issuing and Clearing IPUs, added new subsection on provided procedures relating to IPUs.
(21) IRM 1.11.7.2.3.1.1, Keeping Track of Changes Made to the IRM, changed subsection titled and revised content to remove instructions which are no longer used.
(22) IRM 1.11.7.2.3.2, Updating the Manual Transmittal When Issuing an IPU, added new subsection to provide instruction on how to list IPUs on MT page.
(23) IRM 1.11.7.2.4, Posting the IRM to SERP, added a new subsection to explain the process for posting IRMs to SERP
(24) IRM 1.11.7.2.5, Sending IRM Clearance Documentation to the IRS Historical Library, added a new subsection on the procedures for sending IRM clearance documentation to the IRS Historical Research Library.
Effect on Other Documents
IRM 1.11.7, Accounts Management Tax/Policy Analyst Guide, dated January 1, 2011, is superseded.Audience
Accounts Management IRM Authors/Tax Analysts for Parts 3, 4, 5, 21 and 25 who post their IRM sections on Servicewide Electronic Research Program (SERP).Effective Date
(01-01-2013)Related Resources
Clearance Process Reviewers List can be found at http://win.web.irs.gov/imd.htm.
Ivy S. McChesney
Director, Accounts Management
Wage and Investment Division
-
This IRM section provides guidance to Accounts Management (AM) employees who produce IRM content, job aids, performance support tools, TeleTax and other procedural content. These guidelines are for IRM Coordinators, IRM authors and tax/policy/program analysts within WI AM. The WI program manager/owner has oversight and is responsible for ensuring all procedural content issued in the IRM is accurate and valid at all times.
-
In addition to IRM 1.11.7, the following list of IRMs and documents are useful tools in providing guidance to IRM authors:
-
IRM 1.11.1, IMD Program and Responsibilities
-
IRM 1.11.2, Internal Revenue Manual (IRM) Process
-
IRM 1.11.5, Publishing Internal Management Documents (IMDs)
-
IRM 1.11.6, Using and Researching the Internal Revenue Manual (IRM)
-
IRM 1.11.8, Servicewide Electronic Research Program (SERP)
-
IRM 1.11.9, Clearing Internal Management Documents (IMDs)
-
IRM 1.11.10, Interim Guidance Process
-
Document 12229, IRM Authoring Tool Quick Reference Guide
-
Document 12835, The IRM Style Guide
-
-
Reference to the above IRMs and documents should be used when authoring an IRM and will be referenced accordingly throughout this IRM.
-
Within the AM IMD Program, tax/policy/program analysts, the AM IRM Coordinator, and IRM authors play key roles. The following subsections will discuss their roles and responsibilities.
-
Within the AM IMD Program, tax/policy/program analysts are responsible for:
-
Maintaining information posted to IRS.gov (e.g., Tax Trails, Frequently Asked Questions (FAQs), TeleTax, etc.)
-
Addressing employee suggestions
-
Approving job aids
-
Ensuring training materials are based current procedures
-
-
IRS.gov Updates: The information posted to IRS.gov must be kept current and accurate. Technical changes must be made, as appropriate; this could be daily, monthly, quarterly, or annually. All references and links must be accurate. Analysts should conduct an annual review of all references and links before October 1st each year, to ensure references and links are accurate for the upcoming filing season. Technical changes must be cleared as appropriate, e.g., determine if Chief Counsel must review these changes. Analysts will need to make appropriate contacts to ensure information is forwarded to the correct parties to ensure IRS.gov information is properly maintained. See IRM 11.55.1, Internet Content Publishing Process (ICPP) Management Document.
-
Employee Suggestions: To improve the quality and consistency of procedures, analysts should review and evaluate to employee suggestions, expeditiously; so, the suggestions can be closed out within 75 calendar days (Servicewide processing cycle time goal) from the date the employee suggestion was submitted. Visit the Employee Suggestion Program web page for more information.
-
Job Aids: The IRM author/responsible analyst should approve all job aids (including all locally prepared job aids) used with their IRM(s) and ensure the job aids:
-
Are used as an IRM exhibit, an IRM Job Aid on SERP, a Technical Communication Document (TCD), or as training material.
-
Are “user friendly” and are “made accessible” to meet Section 508 guidelines. See IRM 1.11.8.6.5, Adding Job Aids, for guidance on adding job aids to the Servicewide Electronic Research Program (SERP) and IRM 1.11.8.7.3, Updating All Other Content, for guidance on updating job aids posted to SERP.
-
Contain an IRM reference.
Reminder:
All procedural/instructional information must be in the IRM. A job aid cannot be the sole source of instruction.
-
Are reviewed and updated (as needed) with current IRM references, etc., each time procedures are changes in the IRM.
Note:
All locally prepared job aids must be submitted to the appropriate IRM author/responsible analyst for approval.
-
-
Training Material Updates and Coordination: The IRM author/responsible analyst should ensure training material is based on current IRM procedures.
-
IRM authors/responsible analysts must have up-front conference calls with subject matter experts (SMEs) when updating and/or developing training material. This will ensure that all Continuing Professional Education (CPE) and formal training material is updated with the latest IRM changes.
-
IRM authors/responsible analysts should provide project managers and SMEs with advanced copies of IRMs in order to write training materials effectively.
-
Project managers should contact team coordinators and senior analysts to arrange conference calls to discuss IRM changes/updates. Team coordinators (project management and support teams) are assigned to all training subjects to ensure the process is streamlined and the training materials are consistent.
-
Learning and Education (L&E) must incorporate approved training job aids into existing training material.
-
-
The AM IRM Coordinator:
-
Is contact point for AM IRM authors/managers/analysts regarding the AM IMD program
-
Serves as liaison between AM IRM authors and W&I IMD Team
-
Partners with the W&I IMD Team to assure overall effectiveness of the W&I IMD program
-
Ensures AM IRMs are cleared through all impacted functions (includes internal and external clearances)
-
Supports AM IRM authors (e.g., coaches on use of IRM Authoring Tool software, works with WIT to handle new IRM requests, provides guidance on clearance process, helps them determine who to clear IMDs through, works through issues with W&I IMD Team, reviewers; and works to minimize number of overage IRM
-
Ensures designations for who can approve IRMs and IPUs are kept up to date
-
Keeps IRM coordinators and authors aware of instructions/guidelines related to IMD programs
-
Monitors development of business unit/functional IMDs
-
Partners with W&I IMD Team to develop and enforce annual production schedule
-
Ensures end of year Form 1767s are submitted to prevent delays in IRM processing
-
Works with W&I IMD Team to ensure interim guidance is timely incorporated and expired/superseded interim guidance that met e-FOIA (Freedom of Information Act) is removed from IRS.gov
-
Completes final review of IRM package for completeness using the IRM Authoring Tool software and uploads a zip file of the IRM pack to Publishing
-
Ensures all clearance documents, e.g., signed Form 2061s and comments are sent to the IRS Historical Library
-
-
As part of the AM IMD Program oversight, AM program managers/owners ensure each IRM section is assigned to a specific author who ensures all procedural content issued in the IRM, performance support tools, and TeleTax is accurate and valid at all times, complying with the rules under IRM 1.11.2.5, IRM Authors and the Authoring Process.
Note:
Every attempt must be made to keep procedures up-to date in the published (official) IRM.
-
IRM authors and their managers are responsible for making sure assigned IRM section(s) are current and valid at all times by ensuring:
-
Procedures are accurate.
-
Procedures do not contradict existing procedures, processes or laws.
-
Procedures do not duplicate other IRM procedures.
-
Current business practices are included.
Note:
Desk guides, job aids, (e.g. Technical Communications Documents) or other performance support tools do not provide official procedures or instructions; all procedural/instructional information must be included in the IRM. See IRM 1.11.2.2, What Belongs in the IRM, and IRM 1.11.8.6.5, Adding Job Aids, for SERP requirements for job aids.
-
Procedures identify when specific work areas or units are required to complete certain tasks (e.g., transfer case/call to another area or unit).
-
Official Use Only (OUO) information is properly designated with restrict tags. See IRM 1.11.2.10, Official Use Only (OUO) Information in the IRM, for further instructions.
-
IPUs are issued as interim guidance in the interim of publishing your IRM. See IRM 1.11.7.2.3.1, Issuing/Clearing IPUs.
-
Tables, graphics and exhibits meet Section 508 Accessibility Compliance Requirement. See IRM 1.11.2.8.4, Using Tables, IRM 1.11.2.8.7, Using Graphics, and IRM 1.11.8.5, Writing for 508 Compliant Content, for further instructions.
-
References are accurate as well as references to legal citations. and IRM 1.11.2.8.3.2, Citing Legal Sources.
-
The master IRM file is updated in the Authoring Tool as changes occur; do not wait until the beginning of the annual update to make changes to the IRM file.
-
All procedures are technically reviewed by affected operation divisions, offices and Specialized Reviewers via Document Clearance process. See IRM 1.11.7.2.1.5, Clearing IRMs.
-
All IRM procedures must be approved by the WI AM program director or his/her designee. For AM, senior managers have been designated to approve IRMs for publication, and the IRM author's lead or manager has been designated to approve the issuance of IPUs. See IRM 1.11.7.2.1.6, Obtaining Approval to Publish the IRM.
-
Comments received from clearance reviewers are documented, unless otherwise noted. See IRM 1.11.7.2.1.5, Clearing IRMs.
-
Approval from the responsible program director or designee. See IRM 1.11.7.2.1.6, Obtaining Approval to Publish the IRM.
-
All AM IRMs must be on SERP. SERP related information is included in the IRM updates. SERP IRM Procedural Updates (IPUs), that have been issued between publishing cycles and have not been superseded by a subsequent SERP IPU, are incorporated into the XML file. See IRM 1.11.7.2.3, Updating Your IRM between Publishing.
-
All reviewers' comments and signed Form 2061s, Document Clearance Record, are sent to the IRS Historical Research Library. See IRM 1.11.7.2.5, Sending IRM Clearance Documentation to the IRS Historical Library, for instructions on sending reviewers' comments and signed clearance forms to IRS Historical Research Library.
-
-
IRM sections may require annual revisions and publishing. Your IMD Coordinator prepares the IRM Production Schedule for annual/yearly IRM printing. This schedule will inform you when your IRM is due to Media and Publications (M&P) for timely availability to its users.
Note:
If necessary, an IRM may be published multiple times within one year including updating (publishing) your IRM for editorial corrections. Contact your IRM Coordinator for assistance in determining if an IRM should be republished using the editorial update process and see IRM 1.11.2.13, Making Minor Changes to an IRM Section: Editorial Updates.
-
The Office of Servicewide Policy, Directives, and Electronic Research (SPDER) has Servicewide oversight of the IMD program. SPDER offers IMD Training to IRM authors throughout the year. These training courses can provide just-in-time training to help authors perform jobs effectively and efficiently. A list of available Servicewide IMD training can be found on the SPDER website, IRM/IMD Training page at http://spder.web.irs.gov/imd/training/.
-
IRM authors should contact their IMD/IRM Coordinator to schedule IRM Authoring Tool Training.
-
If an AM IRM author feels additional training, not listed on the SPDER website, is needed, the author should contact the AM IRM coordinator to determine if additional training is available and/or can be scheduled.
-
-
All IRMs must be created and updated using the IRM Authoring Tool software; the current version is Arbortext Editor 5.3. Visit http://xmlhelpdesk.web.irs.gov/irm.html (IRM FAQs), if you need assistance with the IRM Authoring Tool software, or call (202) 622-1557 to report problems. You may also e-mail the help desk at xmlsgmlhelp@irs.gov.
-
If an AM IRM author feels additional training, not listed on the SPDER website, is needed, the author should contact the AM IRM coordinator to determine if additional training is available and/or can be scheduled.
-
All IRMs must be posted on SERP.
-
IRM authors can obtain the current version of an existing IRM XML file from the Electronic Publishing Web site through the IRM Numerical Index at http://publish.no.irs.gov/pubsys/irm/numind.html.
-
Every attempt must be made to keep procedures up-to-date in the published (official) IRM. This may require that an IRM be updated more than once in a year. Contact your IRM Coordinator for assistance in determining if an IRM should be republished multiple times in one year.
-
IRMs go through key phases, which will be discussed in later subsections.
-
Authoring (see IRM 1.11.7.2.1, Authoring the IRM for AM IRM Authors)
-
Updating (see IRM 1.11.7.2.3, Updating Your IRM between Publishing)
-
Clearing (see IRM 1.11.7.2.1.5, Clearing IRMs)
-
Obtaining Approval (see IRM 1.11.7.2.1.6, Obtaining Approval on Publishing an IRM)
-
Uploading (see IRM 1.11.7.2.1.7, Completing Final Review and Uploading the IRM for Publishing)
-
Publishing (see IRM 1.11.5, Publishing Internal Management Documents (IMDs)
-
Archiving (see IRM 1.11.7.2.5, Sending IRM Clearance Documentation to the IRS Historical Research Library)
-
-
If an analyst is assigned ownership of an IRM section, the analyst is responsible for ensuring the guidance is accurate and correct. See IRM 1.11.7.1.1.1, AM IRM Author Roles and Responsibilities, for specifics.
-
The following subsections contain specific instructions for AM IRM authors. The guidance supplements and enforces Servicewide program guidance in IRM 1.11.1, IRM 1.11.1 , IMD Program and Responsibilities,; IRM 1.11.2, Internal Revenue Manual (IRM) Process; IRM 1.11.5, Publishing Internal Management Documents (IMDs); IRM 1.11.9, Clearing Internal Management Documents (IMDs) and IRM 1.11.10 , Interim Guidance Process.
-
As an IRM author, you should first ensure that you have the IRM authoring software, register as an IRM author and complete the IRM Authoring Tool 3 day classroom training. Guidelines to these procedures are listed in IRM 1.11.2.5, IRM Authors and the Authoring Process.
Note:
For IRM Authoring Tool training dates, visit the Servicewide Policy, Directives, and Electronic Research (SPDER) website, IRM/IMD Training page at http://spder.web.irs.gov/imd/training/. The IRM/IMD Training page also contains links to just-in-time (refresher) e-learning modules, e.g., XML for IRM Authors, which is available via Enterprise Learning Management System (ELMS).
-
Use the IRM Authoring Tool software, which is Arbortext Editor 5.3, to update IRM XML files. Training is available via the site at: E-mails are generated to authors when IRM Authoring Tool software updates are available. Visit the XML Help Desk to report problems. You may also call the help desk at (202) 622-1557.
-
Once software has been installed and training has been completed, an author must determine what guidelines and procedures the IRM will contain. It is important that the IRM is accurate and user-friendly. See IRM 1.11.2.6, Authoring Step 1: Getting Ready to Write or Revise an IRM. Analyzing and organizing material that is to be included in the IRM is important as it provides instructions on how employees perform their jobs. Include current business practices and specific procedures that identifies when and what type of work is to be performed. See procedures outlined in IRM 1.11.2.7, Authoring Step 2: Analyzing and Organizing the Material.
-
Writing the IRM should be done in a clear and concise manner:
-
Create links to official sources of information, e.g., IRS official documents, forms and letters, other IRMs, legal references, etc. See Document 12835, IRM Style Guide, and IRM 1.11.2.8.3.5, Citing Website Sources and Creating Links.
-
Create list to allow the reader easily scan and interpret information. See IRM 1.11.2.8.2, Types of Lists.
-
Use a standard format to cite legal sources or other references in the IRM such as IRM sections, the Internal Revenue Code, regulations, court cases, administrative rulings, Congressional Acts, citing the web and creating links and IRS.gov. See IRM 1.11.2.8.3, Standard Citation Standards.
-
Use tables when instructions should be followed in a particular order. See IRM 1.11.2.8.4, Using Tables.
-
Use graphics to illustrate information that is not reproducible in text. Graphics should be a completed form for illustrative purposes only and should contain a verbal descriptive narrative (VDN) to adhere to Section 508 of the Rehabilitation Act of 1998, which requires electronic technology and information to be available to employees with disabilities. See IRM 1.11.2.8.7, Using a Graphic, and IRM 1.11.2.8.7.3 , Verbal Descriptive Narrative (VDNs). Also visit the Alternative Media Center (AMC) website at http://amc.enterprise.irs.gove/index.php.
-
-
The Manual Transmittal appears at the beginning of each IRM section. It contains important information which clearly defines what changes have been made in your IRM, why the changes have been made, and where they can be located. See IRM 1.11.2.9, Authoring Step 4: Preparing the Manual Transmittal, for more information.
-
The Manual Transmittal consists of seven required elements. All seven elements must be completed. See IRM 1.11.2.9.1, Required Elements of the Manual Transmittal.
-
Manual Transmittal Date
-
Purpose
-
Material Changes
-
Effect on Other Documents
-
Audience
-
Effective Date
-
Signature
-
-
For the Manual Transmittal Date, always use Month DD, YYYY. See IRM 1.11.2.9.1.1, Manual Transmittal (MT) Date.
Reminder:
Media and Publications (M&P) changed the IRM dating procedures in May 2011, and the wildcard, Month DD, YYYY, must be used for all IRMs; a specific date can no longer be entered as the MT Date (there are no exceptions—not even for filing season IRMs).
-
For the Purpose, see IRM 1.11.2.9.1.2, Purpose.
-
For the Material Changes, see IRM 1.11.2.9.1.3, Material Changes, and IRM 1.11.2.9.1.4, Material Changes for an Obsolete IRM Section.
-
Ensure all substantial (non-editorial) changes have been identified by subsection and paragraph(s). See IRM 1.11.2.9.2.1.1, Substantial Changes, and IRM 1.11.2.9.2.1.2, Editorial Changes, for more information.
Note:
Editorial changes do not have to be listed individually; only a general statement should be included.
-
List changes in the subsection/exhibit order in which they occur in the IRM, when the IRM is sent out for clearance.
-
For revised IRMs, review all IPUs that have been issued and ensure that any changes that are still reflected in the IRM are included in the Material Changes.
-
-
For the Effect on Other Documents, see IRM 1.11.2.9.1.5, Effect on Other Documents.
-
For the Audience, see IRM 1.11.2.9.1.5, Audience.
-
For the Effective Date, see IRM 1.11.2.9.1.7, Effective Date.
Caution:
All W&I filing season IRMs must use a specific date for the Effective Date. The wildcard (MM-DD-YYYY) should not be used for the Effective Date or subsection dates in filing season IRMs.
Example:
IRM 21.1.1, Accounts Management and Compliance Services Overview, is a filing season IRM that was effective on October 1, 2012; therefore, the Effective Date should be (10-01-2012).
-
For the Signature, see IRM 1.11.2.9.1.8, Signatory (Signed By).
-
See IRM 1.11.2.9.2, Optional Elements, for more information on the following Manual Transmittal elements.
-
Note
-
Background
-
Scope
-
Related Resources
-
-
Whenever a substantial (non-editorial) change is made to a subsection or exhibit, the date should be changed.
-
If the subsection/exhibit was changed based on the issuance of an IPU, the date should be the date the IPU was posted to SERP.
Example:
An IPU was posted to SERP on October 18, 2012 for IRM 21.1.1, Accounts Management and Compliance Services Overview, to change IRM 21.1.17(9)(d); therefore, the subsection date for IRM 21.1.7, should be (10-18-2012).
-
If the subsection was changed, but not as a result of an IPU, the IRM's new Effective Date should be used.
Example:
While updating the IRM file for IRM 21.1.1, Accounts Management and Compliance Services Overview, to send out for clearance, the author identified a change that should be made to Exhibit 21.1.1-1. IRM 21.1.1 is a filing season IRM that is usually effective on October 1 every year; therefore, the date for the updated exhibit should be (10-01-2013).
-
IRM authors should avoid duplicating IRM procedures that are covered in other IRMs by a process’ program owner (including any that cross business unit and business operating division lines). Always refer your reader to the appropriate IRM, document, job aid, system, publication, tax form and/or instructions. See IRM 1.11.2.8.3, Standard Citation Rules, for further instructions.
-
IRM authors should use references to IRMs, legal sources, court cases, other IRS published products (e.g., letters, notices, forms, instructions, publications, etc.), and websites in their IRMs to provide supplementary or administrative information. See IRM 1.11.2.8.3, Standard Citation Rules, and Document 12835, IRM Style Guide, for further instructions.
-
Referencing IRMs: See IRM 1.11.2.8.3.1, Citing to the IRM. When referencing IRMs,
-
Be specific when referring to other procedures or instructions in your IRM. When referencing, include full and correct titles (when titles are provided). Use the complete IRM section/subsection number you are referencing.
Note:
Suggested Practice – Include the IRM section/subsection title the first time it is used in a subsection. Example: If referencing at the IRM section level, e.g., IRM 1.11.2, the reference would be IRM 1.11.2, Internal Revenue Manual (IRM) Process. Example: If referencing at the IRM subsection level, e.g., IRM 1.11.2.3, the reference would be IRM 1.11.2.3, Keeping the IRM Current.
-
For cross-references to subsections, figures, exhibits, etc. within the same IRM, use the " seealso" element of the IRM Authoring Tool, with appropriate type.
Reminder:
Ensure no text besides "IRM" and the section/subsection number are included inside of the "seealso" element tags. Titles should be outside of the "seealso" element.
-
When referencing other IRMs, use the "citation" element of the IRM Authoring Tool.
Reminder:
Ensure no text besides "IRM" and the section/subsection number are included inside of the "citation" element tags. Titles should be outside of the "citation" element.
-
When referencing other IRMs, use the "citation" element of the IRM Authoring Tool.
Reminder:
Ensure no text besides "IRM" and the section/subsection number are included inside of the "citation" element tags. Titles should be outside of the "citation" element.
-
Verify all references to IRMs and their subsections, forms, publications, legal citations, etc. to ensure that they are still correct. Be sure to run the Validate Cross References under Tools of the IRM Authoring Tool.
Note:
The Validate Cross References feature, only validates IRM references within the same IRM, if the "seealso" element was used. This feature does not validate references in"citation" elements
.
-
-
Referencing Legal Sources: See IRM 1.11.2.8.3.2, Citing Legal Sources.
-
Referencing Court Cases: See IRM 1.11.2.8.3.3, Citing Court Cases.
-
Referencing Other IRS Published Products: See IRM 1.11.2.8.3.4, Citing Other IRS Published Products.
-
Referencing Websites: See IRM 1.11.2.8.3.5, Citing Website Sources and Creating Links.
Caution:
Intranet web addresses which show a numerical IP address, e.g., http://123.456.789/documents, are not allowable in IRMs because including these types of web addresses in a publicly available document pose a high risk of disclosing IRS computer systems.
Reminder:
Web addresses should be formatted using the "a" tag in the IRM Authoring Tool software.
Note:
Suggested Practice – Use Intranet web address to link users to information that changes frequently or is used internally such as lists of offices, addresses, telephone numbers or persons to contact.
-
Official Use Only (OUO) in the IRM is restricted information that is not available to the public. It is used for official purposes by authorized individuals. All OUO content is embedded within the IRM. When the IRM is prepared using the IRM Authoring tool, the OUO material is placed within “restrict” tags or attributes. When published, the tagged information is automatically redacted from the public version. See IRM 1.11.2.10, Official Use Only (OUO) Information in the IRM, for further information.
-
All AM IRMs must be technically reviewed by the appropriate analysts, specialized reviewers, business operating divisions, business units/functions, and customers via the Electronic Document Clearance process.
Reminder:
The W&I IMD Coordinator should be included on all W&I IRM clearance requests.
-
IRM authors must determine which specialized reviewers, business operating divisions, business units, and functions need to review their IRMs.
Reminder:
Use the Clearance Process Reviewers List located at: http://win.web.irs.gov/imd.htm as a starting point to identify reviewers for W&I IRMs. If changes need to be made to the list, the IRM author should send the changes to the appropriate member of the W&I IMD Team with a copy to the AM IRM Coordinator.
-
Specialized Review by Disclosure: If the IRM contains OUO content, prepare Form 13709, Disclosure Checklist for Internal Management Documents and Training Materials, and send IRM to Disclosure for clearance review. See IRM 1.11.9.4.2, Governmental Liaison & Disclosure.
Reminder:
OUO material is information that is not revealed to the public.
Note:
If you have any questions concerning Disclosure’s review of your documents, please call your Disclosure Technical Advisor (DTA).
-
Other Specialized Reviewers: Include Office of Chief Counsel, Taxpayer Advocate Service, Legislative Affairs, Office of Taxpayer Correspondence, and Workforce Relations. See IRM 1.11.9.4, Specialized Reviewers, for instructions on when to send an IRM to a specialized reviewer for clearance review.
-
-
During the clearance process, IRM authors should:
-
Determine reviewers with help from W&I IMD coordinator, AM IRM Coordinator, or management, if needed
-
Prepare Form 2061, Document Clearance Record, per instructions in IRM 1.11.9, Form 2061 Document Clearance Record, to obtain concurrence and comments on the IRM.
-
E-mail Form 2061, the draft IRM and new/revised graphics to the identified clearance reviewers.
Reminder:
The IRM XML file will need to be converted to PDF because all reviewers do not have access to the IRM Authoring Tool software.
-
Ensure responses are received; follow-up with reviewers as needed.
Note:
If no response received by final follow-up due date, annotate on Form 2061 that no response received
-
Evaluate all comments received to determine whether you agree and will incorporate the changes into the revised IRM and document the disposition (agree or disagree) of all comments for the historical clearance documentation file.
Reminder:
AM IRM authors must ensure all agreed changes from the document clearance review have been incorporated into the revised IRM XML file before the IRM package is sent forward for approval.
-
Notify the reviewer when a significant comment is not incorporated.
Note:
Suggested Practice – Respond to all reviewers’ comments to indicate whether the comments will be incorporated, and if the comments will not be incorporated, provide a brief explanation.
-
Address disagreements on substantive comments. Make sure all issues have been resolved and if necessary, elevate to management.
-
Make agreed upon changes to IRM XML file.
-
Maintain all clearance documentation, which will later be sent to the IRS Historical Research Library.
Reminder:
AM IRM authors must keep copies (recommend electronic folder with e-mails) of the entire IRM package including all Form 2061s with feedback sheets and resolutions for a minimum of 18 months after the IRM has been published. This documentation serves as a paper trail to show the accuracy of your IRM.
-
-
The IRM approval process consists of obtaining signatures in:
-
Box 10, Form 1767, Publishing Services Requisition (signatory must be signed by an authorize approver listed at http://publish.no.irs.gov/appls/pst01c.html
Note:
In AM, the authorized approver is the IRM author's lead or manager. Contact your IRM Coordinator if you questions regarding approval signatures on Form 1767.
-
Box 13, Form 2061, Document Clearance Record (signatory must be the business unit/functional director or his/her designee)
Note:
In AM, senior managers can approve IRMs on behalf of the AM Director.
-
-
IRM authors should prepare Form 1767, Publishing Service Requisition, per instructions (see IRM 1.11.5.4.1, Preparing Form 1767, Publishing Services Requisition).
-
Once the clearance process has completed and approvals have been obtained, IRM authors must submit the following information electronically to the AM IRM Coordinator for final review and upload to Publishing.
-
Updated IRM XML file
Note:
The file name for the IRM XML file should begin with the catalog number assigned to the IRM and include the IRM # in parentheses, e.g., 32114X (1-11-7).
-
Revised/new graphic files (if applicable)
Note:
All new/updated graphics must be submitted in PDF format. See IRM 1.11.2.8.7.1, Converting a Graphic to PDF
-
Completed/signed Form 1767 (See IRM 1.11.2.5.4.1, Preparing Form 1767, Publishing Services Requisition, and ensure Box 10 of Form 1767 is signed by an authorize approver listed at http://publish.no.irs.gov/appls/pst01c.html).
-
-
The AM IRM Coordinator will perform the final review of the updated IRM and upload the IRM package to Publishing. See IRM 1.11.9.12.1, Final Review by IMD Coordinator, for instructions.
-
The AM IRM Coordinator will complete Document 13000, IRM Package Check Sheet, to ensure IRM package is properly prepared for publishing. See IRM 1.11.5.4, Preparing the IRM Package for Publishing, and IRM 1.11.5.5, Submitting the IRM Publishing Package, for more information.
Reminder:
Additional checks, that are not listed on Document 13000, will also need to be completed, e.g., checking tables for Section 508 compliance, ensuring web addresses are correct and formatted using "a" element, etc.
-
The AM IRM Coordinator will return any IRMs that are not submitted properly. The IRM author must make necessary changes/corrections to IRM package and resubmit the IRM package to the AM IRM Coordinator.
-
Once the AM IRM Coordinator has reviewed the IRM package and coordinated with the IRM author as needed to make changes, the AM IRM Coordinator will prepare the IRM package zip file that will be uploaded to Publishing. The zip file should include:
-
Updated IRM XML file
Reminder:
The file name for the IRM XML file should begin with the catalog number assigned to the IRM and include the IRM # in parentheses, e.g., 32114X (1-11-7).
-
Revised/new graphic files (if applicable) Reminder: All new/updated graphics must be submitted in PDF format. See IRM 1.11.2.8.7.1, Converting a Graphic to PDF
-
Completed/signed Form 1767 (See IRM 1.11.5.4.1, Preparing Form 1767, Publishing Services Requisition, and ensure Box 10 of Form 1767 is signed by an authorize approver listed at http://publish.no.irs.gov/appls/pst01c.html)
-
-
The AM IRM coordinator will upload the IRM package using the IRM Package Submission tool located at http://caps-as2.mcc.irs.gov/irm/japple?PAGE=gov.irs.publish.irm.Upload.
-
To improve the quality and consistency of procedures, IRM authors must evaluate and respond to requests for IRM changes. Change requests may come in the form of:
-
A SERP Feedback
-
An employee suggestion
-
A general request
-
A response to clearance review request
-
-
SERP Feedback: IRM authors must evaluate and respond to SERP Feedback requests for IRM changes within 45 days. See IRM 1.11.8.10, SERP Feedback – Author/Content Owner Responsibilities, and IRM 21.1.2.2.2, IRM 21 – Change Requests, for more information.
-
Employee Suggestion: IRM authors should review and evaluate to employee suggestions, expeditiously; so, the suggestions can be closed out within 75 calendar days (Servicewide processing cycle time goal) from the date the employee suggestion was submitted. Visit the Employee Suggestion Program web page http://esp.web.irs.gov/, for more information.
-
General Change Request (Outside of Clearance Process): IRM authors should evaluate and respond to general requests for IRM changes within a reasonable time frame. The response should include whether the author agrees with the change(s) requested and when agreed upon changes will be incorporated into the IRM; and if author disagrees with change(s) a brief explanation of why the change is not accepted. See IRM 1.11.9.11, Responding to Reviewer’s Comments, for more information.
-
Response to Clearance Review Request: IRM authors must consider all comments provided in response to a clearance review request. It is recommended that authors respond to comments, within a reasonable time frame, to indicate whether the author agrees with the change(s) requested and when agreed upon changes will be incorporated into the IRM. See IRM 1.11.9.11.1, Author Agrees with Comments Made to IRM Revisions, and IRM 1.11.9.11.3, Resolving Disagreements, for more information.
-
WI AM authors must use SERP IPUs to issue interim guidance to notify users of changes to your IRM before the annual updates are made.
-
IPUs revises or corrects existing IRM information on the SERP IRM only. Further procedures on IPUs and how they are submitted for use can be located in IRM 1.11.8.7, Updating Content on the SERP Website.
-
When issuing IPUs, follow IRM 1.11.8.7.1, Updating IRMs through an IRM Procedural Update (IPU).
-
For clearing IPUs, for AM IRM authors, follow general guidelines in IRM 1.11.10.7, SERP IPUs.
-
All IPUs must be evaluated to determine if the they meet Freedom of Information Act (eFOIA) criteria. Follow guidance in IRM 1.11.10.3, Interim Guidance Requiring FOIA Compliance.
-
When using the IRM Authoring Tool, the IRM author has the ability to track or “highlight” recent changes using one of the two features:
-
Change Tracking
-
Compare
-
-
IRM authors MUST turn the Change Tracking feature on before they begin editing their IRM XML files, when preparing the IRM file to issue an IPU.
-
To do this, select Tools - Change Tracking - Track Changes. This toggles the Change Tracking feature on and off using the preferences set in the Track Changes Options dialog box. Track Changes are on when a check-mark is shown next to the Track Changes in the menu. Change tracking will stay on until turned off, even when the document is saved, closed and reopened.
-
When closing the file with changes tracked, a pop-up warning message will appear stating, “IRM file contains Change Tracking markup. Do you want to Accept/Reject changes now?” You can select “No” to keep the changes marked in the file.
Reminder:
The Change Tracking feature must be used when updating your IRM for a SERP IPU submission. See IRM 1.11.8.7.1.1, IRM Authoring Tool - Updating Your IRM XML File for IPU Submission.
-
-
If an IRM author accidently forgets to turn on the Change Tracking feature before the start of editing the IRM XML file, the IRM author does not need to go back and re-input the changes. The IRM author should use the Compare feature in the IRM Authoring Tool.
Note:
The original unchanged file will be necessary for comparison. To use the Compare feature, 1) open the revised IRM XML file, 2) select Tools - Compare - File in the Compare File dialog box, 3) select the original unchanged IRM XML file that is to be compared to, and 4) click Open. The IRM Authoring Tool will generate a comparison file in a separate window. Insertions and deletions are shown making it easy for the reviewer to see the changes.
-
Use one of these features to format the IRM file that is sent out to clearance. After saving the file (select File/Save As (the IRM catalog # (IRM #)), convert the IRM file to a PDF (select File/Print, change printer name to “Adobe PDF”, select OK). This will become the IRM file to send out for clearance review.
-
Four of the seven required elements will change every time the IRM is revised using the IPU process.
-
Manual Transmittal Date
-
Material Changes
-
Effect on Other Documents
-
Effective Date
Note:
The Purpose is another commonly updated element.
-
-
To update the Manual Transmittal Date, always use Month DD, YYYY. See IRM 1.11.2.9.1.1, Manual Transmittal (MT) Date. SERP will insert the MT Date.
-
To update the Purpose, use the following format – This transmits revised IRM X.X.X, Chapter title, Section Title. See IRM 1.11.2.9.1.2, Purpose.
Example:
This transmits revised IRM 1.11.7, Internal Management Documents System, Accounts Management Tax/Policy/Program Analyst Guide.
-
To update the Material Changes, follow IRM 1.11.8.7.1.1, IRM Authoring Tool-Updating Your IRM XML File for IPU Submission.
-
The MT IPU begins after the IRM is published. For the first IPU after publishing, delete all of the Material Changes, except for the paragraph that covers editorial changes made throughout the IRM. The Material Changes should start from scratch and list all of the significant changes made since the IRM was last published.
-
Make sure subsections and paragraph references reflect where the information is currently in the IRM.
Caution:
References may change if multiple SERP IPUs were issued for the same subsection, entire subsections were deleted or added, and/or the IRM was restructured.
-
For IPUs, list changes in the date order in which they were issued, with the most recent dates listed first.
Reminder:
SERP will input the IPU number and date of the IPU at the beginning of each Material Change paragraph based on the referenced IRM subsection/exhibit.
-
Include a brief description of each substantial (non-editorial) change in order for the user to understand what has changed e.g., listing "Clarified procedures" , "Added procedures," or "Updated consistency terms" is not sufficient to explain changes made.
-
-
To update the Effect on Other Documents for a revised IRM:
-
Use one of the following formats – IRM X.X.X dated Month DD, YYYY (effective Month DD, YYYY) is superseded. OR IRM X.X.X dated MM-DD-YYYY (effective MM-DD-YYYY) is superseded.
Note:
The "dated" date is the last published IRM’s Manual Transmittal Date (IRM’s published date) and the "effective" date is the last published IRM’s Effective Date.
-
If IPU(s) have been issued, include the SERP IPU numbers and the dates issued.
Example:
If one IPU issued, use a statement similar to IRM Procedural Update #, issued Month DD, YYYY has been incorporated into this IRM.
Example:
If two IPUs issued, use a statement similar to IRM Procedural Update (IPU) #, issued Month DD, YYYY, and IPU #, issued Month DD, YYYY, have been incorporated into this IRM.
Example:
If more than two IPUs issued, use a statement similar to The following IRM Procedural Updates (IPUs), issued from Month DD, YYYY through Month DD, YYYY, have been incorporated into this IRM: 12UXXXX, 12UXXXX, and 13UXXXX.
See IRM 1.11.2.9.1.5, Effect on Other Documents.
-
-
After the IRM is published, and is EFFECTIVE, the SERP staff downloads the updated IRM Authoring Tool files directly from the Electronic Publishing’s Electronic Web site, converts the files to HTML, and posts the IRM to SERP. This is transparent to the IRM authors.
Note:
For new IRMs, the author must contact SERP to request IRM be posted to SERP. See IRM 1.11.8.7.1, Adding IRMs.
-
The IRS Historical Research Library preserves the history of why changes are made to documents. The library houses the permanent record of changes made to the IRM through the Form 2061, Document Clearance Record (DCR), packages. The information serves to support IRM author inquiries, legal cases, investigations and response to Treasury Inspector General for Tax Administration (TIGTA) or Government Accountability Office (GAO) inquiries.
-
AM IRM authors are required to send all historical information pertaining to the IRM section to the library when they have received notification that their IRM is being processed.
-
Once an IRM has gone through the clearance process and the IRM has been uploaded to Publishing, all of the clearance responses (e.g., signed Form 2061, reviewers' feedback/comments, and provided resolution responses to the reviewers to indicate if the author agrees or disagrees with reviewers' feedback/comments) should be compiled and sent to the IRS Historical Research Library as required in IRM 1.11.9.12.2, Clearance Documents Sent to IRS Historical Research Library. In addition, see IRM 1.11.9.5, Form 2061 Document Clearance Record, for detailed instructions on how Form 2061 should be completed.
-
Before sending the IRM clearance documentation package to the IRS Historical Research Library:
-
Review all Form 2061, to ensure the form is signed by the reviewer.
-
Ensure the package includes a Form 2061 from each reviewer (including non-respondents).
-
Ensure package has all comments and documented disposition (agree or disagree) on comments, along with actions taken related to disagreements.
-
Ensure Box 13 on one of the Form 2061 is signed by the IRM's signatory (the business unit/functional director or his/her designee).
-
-
IRM authors should e-mail the clearance documentation to the librarian at IRMLibrary@irs.gov (copy the AM IRM Coordinator on the e-mail) within 30 days of the IRM being published and/or within 30 days of the date when the author/coordinator is notified that the IRM will be published, e.g., e-mail confirmation from M&P that the IRM is being processed. The clearance documentation should be in zip file(s). Do not send clearance documentation for multiple IRMs using one e-mail. Send clearance documentation for different IRMs on separate e-mails.