shikhar's proposal
To provide the full solution to the developers by providing one stop solution for documentation functionality and architecture to Boost.ublas at the same point of time becoming a team member of the intellectual team of the programming community and understanding their work culture and ethics.
As I was going through the current implementation of doc I found that there is a performance issue due to html format used which are outdated now which makes the usage of them more buggy, less efficient and less productive converting it to a documentation in asciidoc format will make it more productive, efficient and effective.
Reliable documentation for a programmer is important, as the presence of documentation can improve the quality of a codebase and keeps a track of all relevant and quality application's and its aspect. The main focus on working on documentation is to develop, maintain and knowledge transfer to the code fraternity. The documentation if successful prepares a database more easily accessible, help the new entrants to open source and simultaneously simplify the code thereby helping the cut the support costs.
Thus, it is important to reengineer stereotypical view and thought process of the real programmers of not documenting the code. The developer ecosystem should know to utilize more valuable time in documentation then coding.
Time and efforts are required in documenting the code of any organization as important as fulfilling the requirements of our life to sustain and grow. Therefore efforts are required in documenting the code, so that it will help the project in long run. The documentation provides some edge over befits by assisting the new developers of open source who get panicked by observing the hefty codebase. Enhances the overall quality of the code being used by other's. It makes the maintenance of the repository more effective. All the parts of the code base can be tracked easily. Proper documentation can help the system to run seamlessly even during absenteeism and attrition.
The Software developers primarily treat source code important or even as only documentation. For practicing and manifestations, the code should be in detail and very precise. As the source code in its original form can't be read as plain text so in order to make software accessible and to maintain the readability documentation plays an important role. The documentation should be easy to understand, readable and should be written so that it can be used by future stakeholders.
-
At the time of interfacing is done by the external model then the consumer should understand the exposed interfaces by the existing module.
-
Documentation is needed to be effective then it must be maintained along with the code itself. The documentation reflects can be changed as well when it comes to refactoring code. When the code is updated the tracking can be changed into the documentation that all seasoned engineering teams put.
-
Detail documentation plays a critical role when it comes to fixing a bug or a patch to be fixed faster.
-
To extend a module the existing models and the concepts need to be understood in detail.
Apart from writing and designing, the codes are needed to be reviewed, CI testing. It is not correct to give least attention to documentation, as it is one of the best solution that can help to make any changes in future. At the same point of the time emphasis should be given for a proper description that will help in saving a huge amount in future. If someone want s to understand core of coding then all one has to do is point them to documentation. This is going to help in saving a lot of time as human dependencies are reduced. As a developer also understanding any intricacies is going to be supported by the above. Sometimes looking at one section of code may not result in clarity of the other sections related to it which can be clarified with the help of documentation. It is also required when writing how to use API's that can be read outside of the code, as all the service comes with unique API. The colleagues in other department can even read the documentation and know about it. Documentation is user friendly as the code which we write can be changed any time, if they don't meet our expectations.
In my point of view each project has some organizational goals and in order to achieve the goals, the company derives the goals of employees from the organizational goals. As I have a keen interest in understanding the way your organization works, and it will be a great privilege for me to make myself to be fit into as team member in the existing team to contribute the values towards achieving the organizational goals.
Documentation helps new entrants in developer community due to its simple language which is easy to understand and makes the members confident to work on available codebase. As the task becomes complicated on a step wise manner the solution is to have a clear documentation to avoid frustration amongst the community. An ensured activity against the slowdown processes of the team members and avoiding step backs from the allocated work is to review the code from a high level and decide the forward moving action in a given stipulated time and if required to employ new human resource for the same activity. Generally in an organization the experienced contributors provides complicated and less explanatory code which is complex in nature and becomes a hassle to understand. Documentation in plain language can help the less experienced to understand for their inner workings. Documentation requires understanding, summarizing and holding different aspects at the same time, so writing or contributing to the documentation is basically to understand organization by making huge contribution and becoming a team member of organizational culture.
I also assure that I will be able to dedicatedly contribute 100% of my work to achieve the goal set for me. I also find the learning atmosphere at the workplace which will help me with the guidance & opportunity to show my best output & results. The valuation of my skill set and experience matches the value of your esteemed organization which can further provide me with experience to improve & sharpen my skill set to work in professional organization culture. At this very first stage, I would like to thank & appreciate the opportunity given to me to be a part of an intellectual group of professional workforce, where I can discuss & find my pathway for progress.
I shall leave no stone unturned to fulfill my dreams with a great learning curve with hard work and dedication, which I find getting associated with this organization. Given an opportunity by the organization, I will try to put in my best efforts and dedication for the development of organization.
- Use of documentation as a single source to save energy and time
Referring few researches it is estimated that average knowledge worker spends more than two hours per day only in needed information search. Effective documentation can provide a centralized, organized information and knowledge about a task, team or a project (step-by-step instruction and account logins). Latest information can be made available on this platform only so that no one has to spend hours trying to track down credentials, directions and details -digging information through various websites or downloading files. Streamlining the process of team working by spotting bottlenecks and bloated workflows can be achieved by documentation.
- Use of documentation in Quality and Process Control
The approach of flexibility to the team members in their work that suits them will result in best outputs. But at the same point of time organization will ensure consistent results that are delivered on regular basis. Cohesion amongst the team at some level is desired in order to not to look sloppy or uninformed. Documentation encourages knowledge sharing, empowering team members by elevating the understanding of the work process and projects to be finished in time.
- Use of documentation in elimination duplicative work
Documentation is used by the companies to collect research, cataloging projects done in pasts and share the decisions thereby benefitting and reducing rework and time to achieve desired results. It is also helpful to refer and learn from the projects and work carried out in past and improve. The new developers can get helpful directions, guides and notes which they can refer to speed up the responsibilities and new roles. The information in the documentation can be used as resources to work independently by figuring out the answers to the questions and getting solutions to their problems.
- Smart Working
Knowledge is as equal as currency. Being an efficient and irreplaceable person in a team, one must be one stop solution provider thereby developing a sense of security amongst team members and sharing the expertise to achieve organizational goals. Documentation increases the transparency thereby enhancing the collective knowledge of everyone in the team, as it becomes a culture and basic norm for a collaborate and strategic pathway. Everyone in the team can work smarter as the essential information will not be restricted to only one person thereby giving an autonomy to take there own decisions based on the basic information required.
- Motivating and incentivizing the participation of team members for documentation
Absenteeism, layoffs, unexpected departure of an employee to tackle an unfamiliar project, documentation will help to provide instant solutions to all the problems and hurdles within no time although it sounds formal and stiff but documentation should be prioritize by all the team members to develop a stock pile of information that one can lean on in future.
