Collaboration Approach in Guzzle - ja-guzzle/guzzle_docs GitHub Wiki
- Total Knowledge of Guzzle product broken into two parts
- Tools we use for Collaboration
- Wiki
- User stories
- Teams (and Slack in past)/ Email/ whatsapp (calls and text)
- Videos and recordings
- In people heads and in source code
- Historical design items and trails of decision - which are not relevant, but gets housed somewhere for future reference
- The pertinent knowledge in the context of current product and architecture and includes how-to, code knowledge, design decision, third party techs and libraries used etc
Any important docs that you create , or important notes /snippets/illustration you do, please file into Wiki. Its fine that we have to do cleanup. i will take charge of them and streamline. All the grand design items has to be groomed in Wiki and not in Issues. I know that User Stories contains detail design and sometime for crucial item - but major areas like Scheduling etc should be anchored by wiki. Other use of Wiki is support and how-to guides and overarching design areas, tools and approach and tools. Also any other knowledge which does not find a house should go to wiki
This is crucial for defining specs for new features and bugs. If you are giving task to anyone to do , please don't ping him on watchstrap, please put story, as concrete and as detail if possible and if time is constraint then at least gist of it. Person asking/inquiring and other notes in context of that should go here. For R&D I prefer to put in Gitlab (create as story if its not there) and if I am not responding Gitlab then just send me the perm link to the comment and ask me revert on teams - i know its double but i have been doing this for other scrums on actual project. For R&D i want the random discussion to go in the comments and final spec to be gromd in the description of the issue. I hope we can get better at it. Any body can create USER STORY, and if they are random/duplicate I will house keep it and probably take Parth M's help. But don't do anything (even experimentation , prototype without story). If you dn't know where to house it, then put in guzzle_common
For adhoc queries : i want this to be limited only for support related questions. I want key knowledge from this discussion to be extracted and put into support wiki pages or agonist the bugs raised against this items in Gitlab. Any specific behavior tried by users, any sequence etc. We should file it i gitlab. The teams chats gets unmanageable after sometime
I want this to be done for any intricate troubleshooting, new areas (like documentation approach) and some the knowledge sharing session for new member. I am not sure how much of this videos we can use it, but with transcription and text search which MS Streams supports, I hope to use for training other people and also for any documentation. Also they can be easy ones for any new joinee can be asked to go through this videos and come up with the questions rather then we repeating.
I know that intricate knowledge on why did this or that, on how code works, how functionality works to n-th degree of detail, how exception handling works and 100s of combination that the config supports wont be captured. It will be only in peoples head or in the source code. You can find your balance of what of this can go into above four toos - as documenting such things and keeping them upto-date is not humanly possible (its like keeping journal of what I did everyday or last xx yars : including thinking, willing, eating , walking ,wearing and giving a meaning to it)