thefriending / manual

The Friending user manual provides info and tips to help you understand the mobile application.

Friending Manual

Summary

The Friending user manual provides info and tips to help you understand the mobile application. The project is the actualization of a user vision and set of requirements to construct a matchmaking application. The User Manual encodes these requirements as scenarios and use cases, while the Friending prototype presents a high-fidelity vision of the matchmaking application.

Friending

Friending is an online dating, friendship, and social networking mobile application that features user-created questionnaires. Friending has two primary features: joining groups to find people similar to you or signing up for events happening in your local area. Friending is a prototype built with the Proto.io application prototyping tool.

The Friending prototype was built as part of a requirements specification project. The project focused on the development of a user manual around a fictional matchmaking application called Friending. The application centered around user-created questionnaires that could be used to find relationship matches. The user manual was designed with the goal of deceiving the reader into believing that the application existed. A project vision document and set of user requirements guided the development of scenarios and use cases for the application. The user manual created for the requirements specification project is provided in this repository, available as a PDF.

Development

If you are developing on Windows, it is recommended to install the IDE Texmaker, the universal LaTeX editor. This will ensure that the necessary TexLive packages are installed (or can be installed). The IDE Texmaker is the default IDE used in development of the project.

Building

You can build the image using latexmk. To build with pdf2htmlEX, you can either install pdf2htmlEX in your environment, or make use of the docker image. To start the docker image, run the following:

sh start.sh

To build with latexmk, you can do the following:

latexmk -pdf manual.tex

It is recommend to use the build scripts available in build/. These scripts are used in the build pipeline, ensuring that all arguments and attributes are set for compilation of the TeX project. The output pdf manual.pdf is available at the project root, while other build files are available in the output/ directory.

sh build/compile.sh

Acknowledgements

The project icon is retrieved from the Noun Project. The original source material has been altered for the purposes of the project. The icon is used under the terms of the Public Domain.

The project icon is by Stefan Hartmann from the Noun Project.