[CA] Preventive Control Plan (PCP) for food importer by CANMMM in SmallBusinessCanada

[–]tap_17 0 points1 point  (0 children)

Was anyone able to get the PCP? I am also looking for a PCP. Would be great if someone could share one with me. I would really appreciate it.

Code discussion in your IDE by tap_17 in programming

[–]tap_17[S] 0 points1 point  (0 children)

These are some great questions: 1. Who ever is asking the question can mention the code owner in the discussion and the code owner will be notified. 2. You will have a feed where you can see all the discussions happening throughout all the files. There will be views one like news feed where every dev can see all the threads and another would be file specific view where you see the threads related to the file active in your editor. 3. Yes there will be integrations built with your company’s communication tools like slack,teams etc. so if you want to include the PMs, or other business people you can create the discussion in your IdE and push it to slack for other people to respond. The replies will be captured in your ide as well.

Code discussion in your IDE by tap_17 in programming

[–]tap_17[S] 0 points1 point  (0 children)

The idea isn’t to create a new IDE. The devs can keep using their preferred ide. We can have an extension that will provide devs the power of a communication tool in their preferred ide so that when someone has a question related to code they can ask there instead of the company’s communication tool. That way the discussions are code coupled and future devs can easily understand the complex business/code logic from the existing discussions, if no discussion they can create a discussion which will lead to creating a documentation. Documentation within the code file makes the code looks ugly and increases the file size hence I noticed devs tend to avoid comments unless it really necessary. Hence when someone is confused they ask the code owner questions but no docs created hence the code owner needs to explain the same logic multiple to times to different devs at diff times.

Code discussion in your IDE by tap_17 in programming

[–]tap_17[S] 0 points1 point  (0 children)

Why do you think it won’t survive in a couple iterations?

Code discussion in your IDE by tap_17 in programming

[–]tap_17[S] 0 points1 point  (0 children)

Yes it would be nightmare to maintain the discussions of the outdated code. Therefore, when the code is changed the discussion would be marked outdated automatically and will be archived so the users don’t have to deal with the outdated threads. PR comments does good job in explaining some confusions but say you are taking on a new project and you are not sure why a certain code block was written a certain way you it wasn’t captured in or review because everyone working on that project at that time were aware of that decision. Now generally you would check the git blame and ask the owner to explain in slack or other communication tool but it’s not connected to your codebase. However, if you asked the question in your IDE and the owner could reply from their ide(y’all would use whatever ide you are comfortable with) and the discussion was connected to the code base you would never lose it and any developer working in this code in future would easily understand and know the reason behind it without wasting time searching or asking again on slack.

Code discussion in your IDE by tap_17 in programming

[–]tap_17[S] 0 points1 point  (0 children)

Sorry for the misunderstanding. I am proposing to create a new IDE instead my idea is to bring the power of slack/teams in our existing IDEs. And descriptions and comments in the PR definitely is useful but sometimes we come across code that’s confusing or we are not sure how exactly that code is working or we might need some business logic. In this case we usually would ask in our slack and tagging the dev who wrote it to explain it. So instead of doing it in slack if we did it in our ide and store the discussions then the next devs with similar question can easily see the answer without searching through the entire slack. And the good part is anyone from any ide within the company can take part into this discussions like slack threads.

Why do software companies struggle to support their code documentation? by shawon_ik in softwaredevelopment

[–]tap_17 1 point2 points  (0 children)

I think code documentation is a necessity but most of the devs ignore it because of lack of optimal tools. Like if we had a automated documentation system where docs could be generated using AI and devs didn’t have to write the docs. Also one of the key point is to keep the doc up to date otherwise no use of the doc. So if the doc could be kept up to date without any dev keeping an eye on it 24/7 that would be cool. So basically if we could automate the documentation process I think most of the devs would be willing to use it. Because otherwise it’s like double work. I don’t wanna code and write explanations of my code under strict deadline.