System Documentation Templates ?

Hi
I have been set the task of comprehensively documenting our systems, especially backup and recovery processes, troubleshooting etc.
Just wondered if anyone has a link to any templates that I could plug all my info into, rather than fiddling around creating new word docs each time ?
(I know its a bit optimistic, but just thought i'd ask)
Any pointers more than appreciated
Cheers
Ian

Bruce, historically there have been only two different approaches to IT documentation.
Approach 1 - there isn't any
Approach 2 - the documentation is worthless
Both approaches are in wide spread use today.
If you plan on breaking with IT tradition then I suggest you keep it simple. Plain text or html will be readable years from now without having to have the correct version of any piece of software or someone having to reformat the documentation into a new version of some product or worse trying to migrate documentation stored in one product into a different product altogether.
A simple directory structure fillled with application project definition documents, program descriptions, batch cycle descriptions, and glossaries on a network device that is actually backed up rather than just said to be backed up can prove very useful over time.
HTH -- Mark D Powell --

Similar Messages

  • System monitoring templates for SP11

    Dear colleagues,
    could anyone please to share system monitoring templates for SP11 like as http://wiki.scn.sap.com/wiki/display/TechOps/SysMon_SupportedProducts?
    Thanks a lot,
    Alexander

    Dear Roland,
    Is it possible to get it for documentation purposes in any way now? For example, export it out of the existing system.
    With best regards,
    Alexander

  • Library - Display Templates - System Transfer Template

    All my CCA 8.1.x documentation says that the AM should have 3 default Display Templates. Mine has none and I could really make use of the System Transfer Template.
    Has anyone made use of the three default templates? How do I view them?

    I thought I would add a little more background on what I am trying to accomplish.
    We have a client who will need to transfer a large number of customers to a large number of external numbers (500+). We would like to setup these external numbers as Speed Dial entries but it's not possible to transfer a call to a Speed Dial entry. It's frustrating that Oracle never thought to Phone Lists into the Transfer options, only Workgroups, Users and (manually entered) External Numbers.
    Has anyone ever dealt with something like this before?

  • Define Logical Systems and Template Names for BW Reports

    Hi experts
    I would like to know if someone used the mentioned functionality 'Define Logical Systems and Template Names for BW Reports, I would like to know too IF I create a Z REPORT for example in webdynpro and insert it in this configuration it will work and where it will appear in sourcing cockpit?
    sds.
    Javier

    Hello Muthu,
    BW reports will be shown in SRM Box if the corresponding BW roles for SRM are integrated with SRM roles.
    You might to activate the corresponding datasource of this in SRM.
    And since you have to connect the source system to BW, I think you have to define SRM system as logical system in BW.
    Regards,
    Pavan

  • Wanted Oracle AIM documentation templates

    Hi There,
    I would appreciate if someone could be so kind and share/send/upload to me the good old Oracle AIM documentation templates.
    I don't need all only couple of them, for example:
    MD070, RD070, MD120, etc ...
    Thanks in advance.
    Regards,
    Viktoria

    Bruce, historically there have been only two different approaches to IT documentation.
    Approach 1 - there isn't any
    Approach 2 - the documentation is worthless
    Both approaches are in wide spread use today.
    If you plan on breaking with IT tradition then I suggest you keep it simple. Plain text or html will be readable years from now without having to have the correct version of any piece of software or someone having to reformat the documentation into a new version of some product or worse trying to migrate documentation stored in one product into a different product altogether.
    A simple directory structure fillled with application project definition documents, program descriptions, batch cycle descriptions, and glossaries on a network device that is actually backed up rather than just said to be backed up can prove very useful over time.
    HTH -- Mark D Powell --

  • ABAP Documentation Template

    Dear all,
    We're going to standardize the ABAP documentaion format. Current ABAP documentation template at SE38 Documentation is as follows:
    Purpose
    Integration
    Prerequsite
    Features
    Selection
    Standard_Variant
    Output
    Activities
    Example
    However, we would like to create our own documentation template, such as Prog_ID, Programmer, Responsible_BY, etc.
    How to modify the default documentation template? We've tried SE61 but don't know where to start at.
    Regards,
    Thomas

    Yes, we know that we can create custom heading. But we would like to get the template loaded when programmer type in the documentation. So they don't need to type the custom heading again.
    We just found that using SE61 with document class "General Text" and Name "TEMPLATE_RE" stores the ABAP documentation template.
    Any one familiar with SE61 changes? Any tips or suggestion on modifying setting there?
    Message was edited by: Thomas Ng

  • 7.1 | Problems with System-metrics templates generation

    Hi experts.
    I've got a few questions.
    At first im facing a problem after reinstall a DAA on automatic conifguration:
    System-metrics templates generation failed (cause :Unexpected error occurs in task execution. (detail: com.sap.engine.lib.xml.parser.NestedSAXParserException: Fatal Error: com.sap.engine.lib.xml.parser.ParserException: XMLParser: No data allowed here: (hex) 1a, 1b, 56(:main:, row:1, col:3)(:main:, row=1, col=3) -> com.sap.engine.lib.xml.parser.ParserException: XMLParser: No data allowed here: (hex) 1a, 1b, 56(:main:, row:1, col:3)), state:4)
    I found note 1669789 where i have to check my LM-Service Level on Solman 7.1.
    --> Where can i find it? In SLD i cannot see it.
    Then i read that i have to apply the LM-Service patch with JSPM
    --> Isnt JSPM obsolete? I think i have to use SUM? So i thought i have to do a big SPS-Update otherwise?
    The other stuff in the note doesnt help. If my LM-Service is okay, do you have other ideas?
    Thank you for your help!

    I found note 1669789 where i have to check my LM-Service Level on Solman 7.1.
    --> Where can i find it? In SLD i cannot see it.
    Goto systeminfo from http://host:50000 to check LMservice
    --> Isnt JSPM obsolete? I think i have to use SUM? So i thought i have to do a big SPS-Update otherwise?
    LM-service should be updated from SUM and then you have to re-run java upgrader.
    1st enable maintenance mode from agent admin.
    Deploy SCA from SUM
    Disable  maintenance mode from agent admin.
    Run java upgrader from solman_setup
    Divyanshu

  • WDA Documentation Template

    Hello All,
    I am into a SAP ECC 6.0 & EP 7.0 implementation for the Metallurgy industry vertical client based in UK. We have developed some real complex scenarios as WDA services which will be integrated with the portal.
    Now we are following the standard documentation templates recommended by SAP for all developments. But my problem is I am unable to find a proper <b>documentation template for WDA developments</b>.
    If somebody could find me a templates for the same, it would be of valuable help. Points will be rewarded.
    Thanks in advance,
    Supriya

    Hi,
    see Technical specification template for WebDynpro development required
    Regards, Heidi

  • BI/BW Technical Documentation Templates

    Does anyone have any documentation templates that you currently use to document queries, objects, infoproviders that you could share?  Thanks.

    Hi Dianne,
    Try the link below and download ASAP documentation or Roadmap. There are many kinds of template.
    www.service.sap.com/bi --> Services & Implementation --> SAP BW ASAP
    Also check belo thread:
    Template for BW Query Technical documentation
    Regards,
    KK.

  • Documentation Templates

    Hello Experts,
    I have read some documentations about certificate a sap portal solution.
    In this document I have read that SAP provides a various list of templates for the deliverables for certification process.
    Who could tell me a link to these documents and templates ?
    thanks

    Hi Kasee,
    As far as I know, you won't be able to access the final content without a solman system installed. What you can access is the following:
    you may check the structure delivered by the BPR for projects in solution manager at this online reference, but it is just a reference of the structure:
    -https://implementationcontent.sap.com/bpr
    In case you have a solman system but don't wanna use any projects, the business process repository content can be checked this way:
    -http://help.sap.com/saphelp_sm40/helpdata/en/fd/7b3a2c809442798bb0973a740790eb/frameset.htm
    That's the content I could remember right now.
    kind regards, Fabricius

  • Documentation templates and naming coventions

    Greetings all,
    nice to join the SAP community Network
    I have started working in documentation management for a big project, can any please help me to know if SAP recommends some naming conventions and Templates (as part of Best Practices)? There will be more variety of documents in coming days, however as of now below are possible types of documents in scope:
    Business Blueprint
    To Be Processes
    Organizational Structure document (in Solution Manager)
    Configuration Guide
    Authorization Document
    Master Data document
    WRICEF Specifications
    WRICEF Technical Specifications
    Unit Test Cases
    Integration Test Cases
    Functional Test Cases
    UAT Test Case
    Thanks by advance

    Hi again,
    I think that this is a slight misunderstanding. In DMS you create document info records which are like containers for files. These document info records can be classified or some objects can be linked to them.
    But the main content is the uploaded original file. This can be each file format using a workstation application that you have maintained first in DC30.  This file can be a template or a finalized document that is then uploaded to a content server.
    You can also define some templates that can be used to create new original files. For further information please read the online documentation at http://help.sap.com/erp2005_ehp_06/helpdata/en/79/60e9522806b267e10000000a441470/content.htm?frameset=/en/7a/973035624811d1949000a0c92f024a/frameset.htm&current_toc=/en/d1/e8e4535dd4414de10000000a174cb4/plain.htm&node_id=149
    Best regards,
    Christoph

  • Report Documentation Templates

    Hi,
    we need to create documentation covering the reports that we built in CRM On Demand. Does anyone have any templates we could use?
    I can picture how they could be documented, for ex. Report name, Data source, Object + fields and field Properties, etc. But if there already exists something, I would like to take a look at it.
    Regards,
    Gonzalo

    Hi Alex,
    Please could you send me the document template for report development?
    [email protected]
    Cheers
    Ben

  • I Need all Documentation Templates / Blank Formats during 5 phases of SAP

    Hi Friends,
    When we just start SAP implementation afresh. Then we also keep doing lots of documentation (and that too according to what & how SAP suggests). This we do in a phase-wise and in a proper systematic order.
    I need all those blank forms or formats or templates (whatever we call them) which are used from PreProject survey / study / analysis to Project-Preparation to BluePrinting to Project-Realization uptill Go-Live phase.
    These templates / Blank Formats are in MS-Word or MS-Excel sheets.
    I need all these documents templates / Blank Formats because they contain relevant fields to fill-in while implementing an SAP Project.
    Can anybody please provide me all those Templates / Blank Documents because I do not have access to SAP Sevice MarketPlace NOR to SAP Solution Manager.
    I will definitely give full points at my disposal.
    Thanks in advance.
    Regards
    Rajeev
    Message was edited by:
            Rajeev Sharma

    Everything that you need should be provided in the Business Process Repository.

  • Coordinate System of template form

    Hi there,
    we are currently using Headstart 3.4.2 that was adjusted to our clients requirements. One of the requirements was not to work with a real MDI look and feel, that means every Forms-Module is sized to fit exactly into the MDI Window and then maximized. The surrounding MDI window is sized to a 800x600 screen resolution and centered on the screen.
    To achieve this the consultant changed the coordinate system to pixel and therefore a number of program units in the PLLs had to be changed.
    For us this change had a lot of drawbacks especially, because a lot of the delivered Headstart modules make some sizing stuff based on the inch coordinate system.
    On the other hand a pixel based coordinate system seems much more natural to SW developers and therefore I am not sure how to nadle this task after migration to a newer Headstart version.
    Any opinions or experiences out there?
    Thanks in advance
    --Thomas                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               

    @MLBrown,
    I disagree. Although the "Oracle Developer: Advanced Forms and Reports" book by Peter Koletzke and Paul Dorsey was written at the time of Forms 6 and was written primarily to the Client Server topology, this book does cover the topic "Design for the Web" (Chapter 13) which is still valid today. Additionally, there are other topics that are still relevant with web deployed forms, such as Reducing Network Traffic, Message Diff'ing and Optimize the Class File Loading just to name a few.
    Yes, this is an old book, but with the lack of any better books available - it is still a good place to start to get a basic understanding of how to design an Oracle Form for the web; not to mention it is still a good reference for using some of the more advanced features of Oracle Forms like "Basing a Block on a Procedure" or a "From Clause Query", just to name a few. These Forms features haven't changed much since they were introduced.
    @jbleg,
    With respects to the "Template System" referred to in the book. This was not a commercially available product, but a reference to a set of templates that Peter created. The point was to enforce the need to create standards and partially enforce them through the use of Templates. The use of Templates in you design/development process is still a very valid approach and I suggest you review Chapters 10-12 again.
    Craig... B-)

  • Documentation Template for WD project

    Hi Experts,
    Do someone has template for documenting a Dynpro project. We have to document our WD application. Please provide some templates with example you use for documenting your project.
    Regards,
    Vishal.

    Dear Venkatesh,
    Please visit the following links:
    http://service.sap.com/erp
    http://solutionbrowser.erp.sap.fmpmedia.com/ (Functional prespective)
    http://service.sap.com/instguides --> mySAP Business Suite Applications --> mySAP ERP --> mySAP ERP 2005 --> Upgrade
    http://help.sap.com/printdocu/core/Print46c/en/data/pdf/LOVC/LOVC.pdf
    For Functionality Differences pls refer to the below site -
    http://solutionbrowser.erp.sap.fmpmedia.com/
    After opening the site, please select the Source Release Version which is 4.6 b Then Select the Target Release Version which is "mySAP ERP 2005" or ECC 6.0
    Select the Solution Area like Financials, Human Capital Management, Sales....
    Select module like MM, PP, SD, QM.....
    Click on Search
    Then it displays the Release Version and the Delta Functionality. which can be downloaded to a word document if required.
    and also check the release notes of ECC 6.0 in service.sap.com.
    Hope this helps you.
    Do award points if you found them useful.
    Regards,
    Rakesh

Maybe you are looking for