Commit f7e06b78bfae604026e41f3f33752d04b32cd701
1 parent
27de4fd5
Exists in
master
and in
3 other branches
Completing the Features section
Showing
1 changed file
with
60 additions
and
16 deletions
Show diff stats
opensym2017/content/05-features.tex
| 1 | 1 | \section{Features} |
| 2 | 2 | \label{sec:spb} |
| 3 | 3 | |
| 4 | -%TODO: Paulo e Melissa | |
| 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. | |
| 5 | 10 | |
| 6 | -The new generation of the SPB portal is made up of collaborative softwares features. Some of these features were expanded or limited according to government requirements. Other required features was totally developed by the SPB team, because it was not available in any of the integrated software. Whenever possible, the developed code was sent back to official repository of these softwares, as a contribution. | |
| 7 | - | |
| 8 | -As result, we have a platform which integrate and harmonize features like social networking, mailing list, version control system, content management and source code quality monitoring. Our aim was to develop features by reusing functions of the collaborative softwares which integrate the platform. In addition, we tried to keep this integration transparent to end users. | |
| 11 | +As result, we have a platform which integrate and harmonize features like | |
| 12 | +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 | |
| 15 | +addition, we tried to keep this integration transparent to end users. | |
| 9 | 16 | |
| 10 | 17 | \subsection{Software and Software Community} |
| 11 | -In the new SPB portal, each software has a standard set of pages and tools. Besides support pages like FAQ and installation guide, the software has options to download the released versions and several mechanisms of managing the software development within the platform. | |
| 12 | 18 | |
| 13 | -Focusing on the collaborative development, the SPB provides mechanisms to support the dialogue and communication between developers, users and enthusiasts of a software. The software has its own mailing list, where its privacy can be moderated according to the maturity of the software in this aspect. | |
| 19 | +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. | |
| 23 | + | |
| 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. | |
| 14 | 29 | |
| 15 | -Community of a software is a social space where anyone can find members, blogs, a summary of recent activities in the spaces of interaction and any other relevant community-produced content. Logged users can request for membership of the community and community members can access and edit restricted content. For this purpose, many Noosfero features relating to social network and content management was integrated the portal. | |
| 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. | |
| 16 | 36 | |
| 17 | -In order to assist decision-making, the new SPB has acquired assessment and statistical tools. Now, users can rate the software using a score and comment, so this information is displayed to anyone. Moreover, the software dispose a section containing its statistical data, where the values are calculated through data provided by users and the system. | |
| 37 | +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 | |
| 41 | +provided by users and the system. | |
| 18 | 42 | |
| 19 | -The role of administrator is present in the software and in its community. The administrator is responsible for moderating content, memberships and user comments. He is also the one who can make changes in the software homepage content. | |
| 43 | +The role of administrator is present in the software and in its community. The | |
| 44 | +administrator is responsible for moderating content, memberships and user | |
| 45 | +comments. He is also the one who can make changes in the software homepage | |
| 46 | +content. | |
| 20 | 47 | |
| 21 | 48 | \subsection{Software Catalog and global search} |
| 22 | 49 | |
| 23 | -The user can find some softwares highlighted on the portal homepage, but the best way to search for all available softwares is via the Software Catalog. In this catalog, some search options were developed to improve the navigation, such as filters by kind of software or categories, sorting and score. | |
| 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. | |
| 24 | 54 | |
| 25 | -Expanding the scope of search to cover other kinds of content, the SPB team developed the global search tool. This tool integrates the search mechanisms provided by the collaborative softwares that make up the platform. Any user can find a public content in the context of social network, mailing list and software development. | |
| 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 | |
| 58 | +find a public content in the context of social network, mailing list and | |
| 59 | +software development. | |
| 26 | 60 | |
| 27 | 61 | \subsection{Software development tools} |
| 28 | 62 | |
| 29 | -In addition to interests of users and government agents, the new SPB provides tools to encourage developers of each software to keep the source code and its development within the platform. Any created software has, by default, a related git repository with wiki pages and issues tracking. These tools are supplied by the integration of Gitlab into the platform. | |
| 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 | |
| 66 | +related git repository with wiki pages and issues tracking. These tools are | |
| 67 | +supplied by the integration of Gitlab into the platform. | |
| 30 | 68 | |
| 31 | -The developers can also evaluate the software source code to measuring software quality.. | |
| 32 | -%TODO: Paulo | |
| 33 | -%Explain about Mezuro | |
| 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 | |
| 71 | +metric results evolution over time. Results of each metric analysis are | |
| 72 | +public, what allows greater transparency between the developer and the | |
| 73 | +community that uses the software. Thereby, the maintainers can decide if the | |
| 74 | +given solution meets the source code quality requirements. | |
| 34 | 75 | |
| 35 | -Thus, the SPB becomes a platform to stimulate the openness of the source code, the dialog between users of the software and its development team as well as the software maintenance and evolution. This, therefore, fosters the transparency in the government investments. | |
| 36 | 76 | \ No newline at end of file |
| 77 | +Thus, the SPB becomes a platform to stimulate the openness of the source code, | |
| 78 | +the dialog between users of the software and its development team as well as | |
| 79 | +the software maintenance and evolution. This, therefore, fosters the | |
| 80 | +transparency in the government investments. | ... | ... |