Product Documentation
SpiraPlan

Please find below our complete list of documentation for SpiraPlan®. To view a document, click on the link.

To download a document, right-click on the icon and select, "Save Target As..." and then browse to the appropriate place in on your local computer where you want to save it. When you are satisfied with the location click Save/OK.

To read the documents, you will need a copy of Adobe Acrobat Reader® 5.0 or greater.

Format Description

SpiraPlan Product Datasheet
Provides a high level overview of the system's functionality, together with a list of the key benefits and features.

We recommend you read this before the user guide and administrative guide to understand the full power of SpiraPlan®.

Learn how you can create project requirements, manage release/iteration plans, execute tests and track defects from within one application

SpiraPlan Overview Presentation
Provides a high level overview of the project management and quality assurance that are available in SpiraPlan, and how you the system when first starting a project
SpiraPlan Documentation Site
This is the home page of the core SpiraPlan documentation website. All of the other documents listed below are now hosted on this website as specific sections.
SpiraPlan Quick Start Guide
Introductory guide that walks you through how to start using the system. It describes how to create requirements and user stories, create test cases, execute tests, plan iterations/sprints and log defects.
SpiraPlan User Manual
Contains detailed information on all aspects of using the software. This document is intended for all users of the software.
SpiraPlan Administration and Installation Guide
Contains detailed instructions for easily installing the software as well as an authoritative reference for administering the system once up and running.
SpiraPlan v7.x Release Notes
This outlines what issues have been addressed in the various releases of v6.x, and what new features have been added.
SpiraPlan v6.x Release Notes
This outlines what issues have been addressed in the various releases of v6.x, and what new features have been added.
SpiraPlan Development Roadmap
This roadmap document outlines the functionality currently planned for the next 3-4 releases of the system.
SpiraPlan RemoteLaunch Overview Presentation
This presentation describes the role of automated testing in a quality assurance system. It also describes how to use SpiraPlan in conjunction with Spira RemoteLaunch for managing the test automation process.
SpiraPlan RemoteLaunch Automated Testing Integration Guide
This guide outlines how to use SpiraPlan and Spira RemoteLaunch in conjunction with a variety of automated functional and performance/load testing tools. The systems currently supported include: TestComplete, QuickTestPro, Selenium, Squish, SmarteScript and Command-Line.
SpiraPlan Automated Unit Testing Integration Guide
This guide outlines how to use SpiraPlan in conjunction with a variety of automated unit testing tools. The systems currently supported include: NUnit, JUnit, TestNG, PyUnit, Ruby Test::Unit, Perl TAP and PHP unit testing frameworks.
SpiraPlan Version Control Integration Guide
This guide outlines how to use SpiraPlan in conjunction with a variety of Software Configuration Management (SCM) / Version Control tools. This allows you to browse their repositories directly in SpiraPlan and to link requirements, tasks and incidents to source code revisions.
SpiraPlan Migration and Integration Guide
This guide describes how to import and export data from a variety of systems into SpiraPlan. The systems currently supported include: HP Quality Center, Mercury TestDirector, Microsoft Excel, Microsoft Word and Microsoft Project.
SpiraTest Help Desk Integration Guide
This guide outlines how to use SpiraPlan in conjunction with other help desk systems such as ZenDesk. The intregrations allow you to log defects directly in SpiraPlan from your help desk tickets.
SpiraPlan Email Integration Guide
This guide outlines how to use SpiraPlan in conjunction with your existing email system to scan inbound emails and either log new incidents in the system or add comments to existing artifacts.
SpiraPlan IDE Integration Guide
This guide describes how to integrate SpiraPlan with popular Integrated Development Environments (IDE) such as Eclipse / Mylyn and Microsoft Visual Studio. The integration allows developers to review their requirements, complete assigned tasks and fix assigned incidents/defects directly in their IDE.
SpiraPlan Requirements Management Integration Guide
This guide describes how to use SpiraPlan with a variety of different external requirements management systems. The systems currently supported include: IBM Rational DOORS and RequisitePro, Sparx Enterprise Architect, and Jama Contour.
SpiraPlan External Bug Tracking Integration Guide
This guide describes how to use SpiraPlan with a variety of different external bug/issue tracking systems. The systems currently supported include: Atlassian JIRA, Fogbugz, Bugzilla, Microsoft Team Foundation Server and Mantis.
SpiraPlan Build Server Integration Guide
This guide describes how to use SpiraPlan with a variety of different continuous integration build servers. The systems currently supported include: Jenkins and Hudson.
SpiraPlan High Availability and Backup & Recovery Information
This presentation outlines the different approaches to installing SpiraPlan for maximum availability as well as recommendations for backing up and restoring the system in the event of a hardware/software failure.
SpiraPlan API Documentation
This displays the online Application Programming Interface (API) documentation that describes the different REST and SOAP Web Service functions that are available for use in integrating SpiraPlan with other systems.
SpiraPlan SOAP API Documentation (v6.0)
This displays the online Application Programming Interface (API) documentation that describes the different SOAP Web Service functions that are available for use in integrating SpiraPlan with other systems. Note: This link refers specifically to the v6.0 API.
SpiraPlan REST API Documentation (v6.0)
This displays the online Application Programming Interface (API) documentation that describes the different REST Web Service functions that are available for use in integrating SpiraPlan with other systems. Note: This link refers specifically to the v6.0 API.
SpiraPlan Software Development Kit (SDK)
This zipfile contains sample Visual Studio 2010 C# projects for creating a test automation plugin for SpiraPlan RemoteLaunch, a version control plugin for integrating SpiraPlan with a Software Configuration Management (SCM) system, and a data-synchronization plugin for integrating SpiraPlan with an external bug/issue-tracking system.

View Documentation Archive