Interface Documentation

Window Name
Main Page
Screenshot of Window
Description
Main page of website, contains welcome message and links to individual project subsites.
Sections
Header Section with webpage name and navigation links.
Introduction Message Section with a short introduction of owner with a picture in the background.
Projects Section with links to the projects documentation pages.
Footer Section with copyrights information.
Actions
Home Link to the greeting message on main page.
Projects Link to the Projects section of main page.
Projects Links Links to the projects pages with documentation.
Window Name
Project Main Page
Screenshot of Window
Description
Main page of project documentation, contains title and index with links to documentation pages.
Sections
Header Section with webpage name and navigation links.
Technology Logo Logo of the main technology used in the project.
Project Title Full title of the project.
Index Index of all project documentation pages.
Next Link to next page of documentation.
Additional Media Link to any additional project media.
Footer Section with copyrights information.
Actions
Home Link to the greeting message on main page.
Project Link to the project main page.
Project Pages Links Links to the project documentation pages, such as scope or requirements.
Next Link to the next project documentation page listed in index. Project main page doesn't have 'Previous' link.
Project Media Link Link to the project media, such as code documentation or website link.
Window Name
Project Scope Page
Screenshot of Window
Description
Page that shows the project scope in the form of table.
Sections
Header Section with webpage name and navigation links.
Page Title Section with a title of page.
Project Scope Table Section with table containing information about project scope.
Navigation Links Section with links to previous and next pages according to project index.
Footer Section with copyrights information.
Actions
Home Link to the greeting message on main page.
Project Link to the project main page.
Previous Link to the previous project documentation page according to index.
Next Link to the next project documentation page according to index.
Window Name
Project Requirements Page
Screenshot of Window
Description
Page that shows the project functional and non-functional requirements.
Sections
Header Section with webpage name and navigation links.
Table Title Section with a title of table.
Project Functional Requirements Table Section with table containing information about project functional requirements.
Table Title Section with a title of table.
Project Non-functional Requirements Table Section with table containing information about project non-functional requirements.
Navigation Links Section with links to previous and next pages according to project index.
Footer Section with copyrights information.
Actions
Home Link to the greeting message on main page.
Project Link to the project main page.
Previous Link to the previous project documentation page according to index.
Next Link to the next project documentation page according to index.
Window Name
Project Interfaces Page
Screenshot of Window
Description
Page that shows the project interfaces documentation.
Sections
Header Section with webpage name and navigation links.
Page Title Section with a title of page.
Interface Table Section with table containing details about an interface part: name, screenshot, description, sections and actions. This section is repeated as much times as there are interface parts in project.
Navigation Links Section with links to previous and next pages according to project index. If this page is the last one in index, the 'Next' link does not exist.
Footer Section with copyrights information.
Actions
Home Link to the greeting message on main page.
Project Link to the project main page.
Previous Link to the previous project documentation page according to index.
Next Link to the next project documentation page according to index. If this is the last page in index, this action does not exist.
Window Name
Project Bibliography Page
Screenshot of Window
Description
Page that shows the list of project bibliography.
Sections
Header Section with webpage name and navigation links.
Page Title Section with a title of page.
Bibliography Section with a list of sources used while working on a project. Each item contains name of author, title, publishing information, pages range and year
Navigation Link Section with link to previous page according to project index.
Footer Section with copyrights information.
Actions
Home Link to the greeting message on main page.
Project Link to the project main page.
Previous Link to the previous project documentation page according to index.
Window Name
Sphinx Generated Code Documentation
Screenshot of Window
Description
These pages are generated by Python library Sphinx with RTD theme. Each page contains sections and actions that are standard for this type of pages. Only first page has been slightly modified to add the possibility of returning to Software Documentation Website.