CPU business and Information Technology College
Technical Documentation Suite for "ConnectU" Campus App
Phase 1: Documentation Needs Identification & Scoping
Scope of Work (SOW)
Project Title: Technical Documentation Suite for ConnectU Campus App
Prepared by: [Your Full Name]
Date: [Insert Date]
1. Project Overview & Goals
The ConnectU application is designed to streamline campus life by offering features such as
course management, a personal task manager, and a campus events board.
The primary goal of this project is to develop a full suite of technical documents that support
students, faculty, and developers in using and integrating with ConnectU.
The documentation will enhance user understanding, reduce onboarding time, and enable
seamless third-party API integrations.
2. Target Audiences and Their Needs
Audience Documentation Needs
How to register, log in, manage tasks, view courses and
Students (End-users)
events.
Posting and managing campus events, overview of student
Faculty/Administrators
usage analytics (if applicable).
Developers (Future Devs or API reference documentation to fetch public event data for
Integrators) other campus systems.
3. Deliverables
User Guide (Students)
Admin Guide (if required later)
API Reference Document
Glossary
FAQ Page or How-to Video
Final Polished Documentation Package
4. Exclusions
No documentation for server infrastructure or backend deployment.
No training guides for internal IT maintenance.
No in-depth UX research summaries.
5. Assumptions
Users have basic digital literacy.
All users access the app via modern browsers or updated mobile OS.
Developers understand basic web API integration concepts
6. Timeline & Milestones
Week Task
1 Phase 1: Identify documentation needs and define project scope
2 Phase 2: Design document structure and templates
3-4 Phase 3: Develop content (User Guide, API Reference, Glossary)
5 Phase 4: Peer review, editing, and final packaging
Phase 2 – Design Documentation Structure
Structure_Justification.pdf
Our documentation suite is organized into clearly defined sections for each audience, ensuring
ease of navigation and comprehension:
User Guide (PDF): Simple navigation with clear instructions and visuals for students.
API Reference (HTML): Developer-friendly format with syntax highlighting and
sample code blocks.
Glossary (PDF): Common terms defined in plain language.
Templates are designed with:
o Readability in mind (accessible fonts, color contrast)
o Logical hierarchy (H1 for titles, H2 for sections, H3 for sub-sections)
o Defined blocks for notes, warnings, and code
This structure ensures consistency, reduces cognitive load, and aligns with industry-standard
technical documentation practices.
Document Templates
User_Guide_Template.docx
Includes:
Cover Page
Table of Contents
Sections for: Registration, Login, Managing Tasks, Viewing Events
Style guide: H1 (Title), H2 (Section Title), Body Text (11pt Calibri), Note box,
Screenshot placeholders
API_Template.html
Includes:
HTML skeleton with GET endpoint documentation
JSON response example in <pre> blocks
Sections: Endpoint Summary, Parameters, Response Format, Examples
Phase 3 – Documentation Development
User_Guide_v1.pdf
ConnectU User Guide – For Students
1. Getting Started
o How to create an account
o Logging in to your dashboard
2. Managing Tasks
o Add new task ➕
o Mark tasks as completed ✅
o Organize tasks by category
3. Courses
o Viewing current courses
o Checking schedules
4. Events
o Access campus events board
o Event filters by category or date
API_Reference_v1.html
html
CopyEdit
<h1>ConnectU Public Events API</h1>
<p><strong>Endpoint:</strong> https://api.connectu.edu/events/public</p>
<p><strong>Method:</strong> GET</p>
<h2>Response Example</h2>
<pre>
{
"events": [
{
"title": "Career Workshop",
"date": "2025-08-15",
"location": "Main Auditorium"
},
...
]
}
</pre>
<p>Returns a list of public campus events in JSON format.</p>
Glossary_v1.pdf
Term Definition
API A way for applications to communicate with each other.
Endpoint A specific URL where the API can be accessed.
JSON A lightweight format used to structure data, often used in APIs.
Task Manager A tool in the app where users manage personal and academic tasks.
Events Board A section in the app displaying upcoming campus events.
Authentication The process of verifying a user’s identity to log into the system.
Phase 4 – Evaluation & Editing
Feedback_Summary.pdf
I received the following peer feedback:
“The task section could use more screenshots for clarity.”
“Glossary definitions are clear, but consider shortening some.”
“API doc could use a response status code section.”
Changes Made:
Added 2 additional screenshots for the "Add Task" flow.
Simplified glossary definitions to be more concise.
Included HTTP status code explanation (200 OK, 404 Not Found) in the API Reference.
Alternative Format – FAQ.pdf
Frequently Asked Questions (Students)
1. How do I register for ConnectU?
➝ Tap on "Sign Up" and fill in your school email and ID.
2. Can I add personal tasks?
➝ Yes, the Task Manager lets you organize personal and course-related tasks.
3. Where can I find event updates?
➝ Go to the Events tab to browse upcoming workshops, sports, and activities.
4. Can I access the app from my phone?
➝ Yes, it’s available on both web and mobile platforms.
5. What if I forget my password?
➝ Use the "Forgot Password?" link to reset it via your registered email.
Final Deliverables Checklist
User_Guide_FINAL.pdf
API_Reference_FINAL.html
Glossary_FINAL.pdf
FAQ.pdf (Alternative Format)
Feedback_Summary.pdf
Thank You!!!
