Commit 24ba67d4bdd9ca575ffacbc09bf33a9d14879bb2
1 parent
2b624ece
Exists in
master
and in
2 other branches
Final review of features section
Showing
1 changed file
with
38 additions
and
44 deletions
Show diff stats
opensym2017/content/05-features.tex
| 1 | \section{Features} | 1 | \section{Features} |
| 2 | \label{sec:spb} | 2 | \label{sec:spb} |
| 3 | 3 | ||
| 4 | -The new generation of the SPB portal is made up of collaborative softwares | ||
| 5 | -features. Some of these features were expanded or limited according to | ||
| 6 | -government requirements. Other required features was totally developed by the | ||
| 7 | -SPB team, because it was not available in any of the integrated software. | ||
| 8 | -Whenever possible, the developed code was sent back to official repository of | ||
| 9 | -these softwares, as a contribution. | 4 | +The new generation of the SPB portal combines adapted features of existing collaborative softwares |
| 5 | +and features developed by the SPB team. Whenever possible, new functions | ||
| 6 | +(newly developed or partially modified) were sent to official repositories, as a contribution. | ||
| 10 | 7 | ||
| 11 | -As result, we have a platform which integrate and harmonize features like | 8 | +As a result, we have a platform that integrates and harmonizes different features such as |
| 12 | social networking, mailing list, version control system, content management and | 9 | social networking, mailing list, version control system, content management and |
| 13 | -source code quality monitoring. Our aim was to develop features by reusing | ||
| 14 | -functions of the collaborative softwares which integrate the platform. In | 10 | +source code quality monitoring. Our aim was to develop functionalities by reusing |
| 11 | +functions of collaborative softwares already integrated to the platform. In | ||
| 15 | addition, we tried to keep this integration transparent to end users. | 12 | addition, we tried to keep this integration transparent to end users. |
| 16 | 13 | ||
| 17 | \subsection{Software and Software Community} | 14 | \subsection{Software and Software Community} |
| 18 | 15 | ||
| 19 | In the new SPB portal, each software has a standard set of pages and tools. | 16 | In the new SPB portal, each software has a standard set of pages and tools. |
| 20 | -Besides support pages like FAQ and installation guide, the software has options | ||
| 21 | -to download the released versions and several mechanisms of managing the | ||
| 22 | -software development within the platform. | 17 | +Besides accessing support pages (such as FAQ and installation guide) within the platform, users will be able to download |
| 18 | +different versions of the software and find several mechanisms of software development management. | ||
| 23 | 19 | ||
| 24 | -Focusing on the collaborative development, the SPB provides mechanisms to | ||
| 25 | -support the dialogue and communication between developers, users and | ||
| 26 | -enthusiasts of a software. The software has its own mailing list, where its | ||
| 27 | -privacy can be moderated according to the maturity of the software in this | ||
| 28 | -aspect. | 20 | +Focusing on the collaborative development, the Mailman was integrated to the platform in order to allow |
| 21 | +the dialogue and communication between developers, users and | ||
| 22 | +enthusiasts of a determined software. The software has its own mailing list whose privacy | ||
| 23 | +can be configured/set by administrators. | ||
| 29 | 24 | ||
| 30 | -Community of a software is a social space where anyone can find members, blogs, | ||
| 31 | -a summary of recent activities in the spaces of interaction and any other | ||
| 32 | -relevant community-produced content. Logged users can request for membership of | ||
| 33 | -the community and community members can access and edit restricted content. For | ||
| 34 | -this purpose, many Noosfero features relating to social network and content | ||
| 35 | -management was integrated the portal. | 25 | +The software has a social interface area (aka "software community") where users can find other users, blogs, |
| 26 | +summary of recent activities, or any other relevant community-produced content. | ||
| 27 | +Users logged to the platform can request membership to different software communities | ||
| 28 | +and each community member can access and edit restricted content. For this purpose, | ||
| 29 | +many Noosfero features related to social network and content management was integrated to the portal. | ||
| 36 | 30 | ||
| 37 | To assist decision-making, the new SPB has acquired assessment and statistical | 31 | To assist decision-making, the new SPB has acquired assessment and statistical |
| 38 | -tools. Now, users can rate the software using a score and comment, so this | ||
| 39 | -information is displayed to anyone. Moreover, the software dispose a section | ||
| 40 | -containing its statistical data, where the values are calculated through data | 32 | +tools. Now, users will be able to rate the software and make comments and all |
| 33 | +information will be avaiable to other users. Moreover, the software has a section | ||
| 34 | +containing its statistical data, where values are calculated through data | ||
| 41 | provided by users and the system. | 35 | provided by users and the system. |
| 42 | 36 | ||
| 43 | -The role of administrator is present in the software and in its community. The | 37 | +The role of the administrator will be present in the software and in its community. The |
| 44 | administrator is responsible for moderating content, memberships and user | 38 | administrator is responsible for moderating content, memberships and user |
| 45 | comments. He is also the one who can make changes in the software homepage | 39 | comments. He is also the one who can make changes in the software homepage |
| 46 | content. | 40 | content. |
| 47 | 41 | ||
| 48 | \subsection{Software Catalog and global search} | 42 | \subsection{Software Catalog and global search} |
| 49 | 43 | ||
| 50 | -The user can find some softwares highlighted on the SPB portal homepage, but | ||
| 51 | -the best way to search for all available softwares is via the Software Catalog. | ||
| 52 | -In this catalog, some search options were developed to improve the navigation, | ||
| 53 | -such as filters by kind of software or categories, sorting and score. | 44 | +The platform also provides a search tool called Software Catalog, |
| 45 | +which allows users to find softwares available in its directory. | ||
| 46 | +In this catalog, some search options were developed to make the navigation easier, | ||
| 47 | +such as filters (by type of software or category), sorting and score. | ||
| 54 | 48 | ||
| 55 | -Expanding the scope of search to cover other kinds of content, the SPB team | ||
| 56 | -developed the global search tool. This tool integrates the search mechanisms | ||
| 57 | -provided by the collaborative softwares that make up the platform. Any user can | 49 | +In order to expand the searching scope and cover more types of content, the SPB team |
| 50 | +developed the global search tool. This tool unifies search mechanisms | ||
| 51 | +provided by the mentioned collaborative softwares. Any user can | ||
| 58 | find a public content in the context of social network, mailing list and | 52 | find a public content in the context of social network, mailing list and |
| 59 | software development. | 53 | software development. |
| 60 | 54 | ||
| 61 | \subsection{Software development tools} | 55 | \subsection{Software development tools} |
| 62 | 56 | ||
| 63 | -In addition to interests of users and government agents, the new SPB provides | ||
| 64 | -tools to encourage developers of each software to keep the source code and its | ||
| 65 | -development within the platform. Any created software has, by default, a | 57 | +The new SPB also provides |
| 58 | +tools to encourage developers to keep each source code and its | ||
| 59 | +developments within the platform. Any created software has, by default, a | ||
| 66 | related git repository with wiki pages and issues tracking. These tools are | 60 | related git repository with wiki pages and issues tracking. These tools are |
| 67 | supplied by the integration of Gitlab into the platform. | 61 | supplied by the integration of Gitlab into the platform. |
| 68 | 62 | ||
| 69 | -The developers can also evaluate the software source code to measuring software | ||
| 70 | -quality. With Mezuro, they can schedule the analysis and follows source code | 63 | +Developers can also evaluate the software source code to measure software |
| 64 | +quality. With Mezuro, they can schedule the analysis of the source-code and follow its | ||
| 71 | metric results evolution over time. Results of each metric analysis are | 65 | metric results evolution over time. Results of each metric analysis are |
| 72 | -public, what allows greater transparency between the developer and the | 66 | +public, which allows greater transparency between the developer and the |
| 73 | community that uses the software. Thereby, the maintainers can decide if the | 67 | community that uses the software. Thereby, the maintainers can decide if the |
| 74 | given solution meets the source code quality requirements. | 68 | given solution meets the source code quality requirements. |
| 75 | 69 | ||
| 76 | -Thus, the SPB becomes a platform to stimulate the openness of the source code, | ||
| 77 | -the dialog between users of the software and its development team as well as | ||
| 78 | -the software maintenance and evolution. This, therefore, fosters the | ||
| 79 | -transparency in the government investments. | 70 | +Thus, the SPB becomes a platform to stimulate the openness of the source code; |
| 71 | +dialogue between users and the development team; and also | ||
| 72 | +maintenance and evolution of the software, which will provide more | ||
| 73 | +transparency in government investments. |