anbahl34 / test

0 stars 0 forks source link

This is a new issue rename #6

Open anbahl34 opened 11 months ago

anbahl34 commented 11 months ago

Feature Description (What)?

We have made recent improvements to code blocks. These improvements allow users to share code using code blocks in markdown and also specify the language while doing so. There are a few issues today that will act as adoption blockers for the newly shipped code block -

  1. While using code blocks in markdown using triple back tick is known, language specification within code blocks is not so common within collab tools but rather in some developer tools like VS, VS Code, GitHub. 
  2. We provide no indication today to users that -
    1. Do not have a dedicated entry point for code blocks in format options in compose
    2. We support language specification and syntax highlighting. The only information where users will be able to learn that this functionality is supported is in the public documentation for support of markdown in Teams (which is a rarely visited by end users)
    3. There is no way to know which languages are supported in code blocks.
  3. How do we determine that this is an issue?
    1. The best way to determine if this s an issue is to see the usage of language specification as a percentage of usage of code blocks. Insights > Code sharing in Teams Desktop (interana.com)
    2. (As of 5/1) Currently Language specification is in R3 and telemetry for language specification is recently implemented and now flowing. Soon we will have data to backup this hypothesis that language specification is an issue

Customer/business problem addressed (Why)?

This is part of Project Unicorn's effort to make the product more compelling for developers, digital natives and slack holdouts. The current implementation of language specification of code blocks will deter the quick adoption. This feature will help improve the learning curve of language specification in code blocks

What is the key result that this feature is expected to drive (Key Results)?

Key Results to drive with this feature -
  1. Increase usage of language specification 
  2. % of code blocks shared with language specification
  3. Reduce the reliance of code snippets for users to share code in Teams

High Level Requirements are listed here -

Req # | Statement | Pri -- | -- | -- 1 | Code Block Discoverability |     |   |   1.1 | When user does ```ticks, there should be a way for the user to see or pick the languages supported | P1 1.2 | Introduce new button in format options for code block | P1 1.3 | When code block is invoked, the format options should show code block selected. | P1 1.4 | If the user clicked on the Format options button entry point of code block to initiate the code block, the user should have an option to pick the language specified. | P1 1.5 | User can change the language in the code block at any time | P2   |   |  

Here are some examples for design inspiration-
  1. Language drop down on triple back tick -
    Image
    2. Once the language is specified, it is shown to the user as they type out their code. (This is specifically beneficial when the user uses the button to invoke a code block)
    Image

Feature Description (What)? We have made recent improvements to code blocks. These improvements allow users to share code using code blocks in markdown and also specify the language while doing so. There are a few issues today that will act as adoption blockers for the newly shipped code block - While using code blocks in markdown using triple back tick is known, language specification within code blocks is not so common within collab tools but rather in some developer tools like VS, VS Code, GitHub. We provide no indication today to users that - Do not have a dedicated entry point for code blocks in format options in compose We support language specification and syntax highlighting. The only information where users will be able to learn that this functionality is supported is in the public documentation for support of markdown in Teams (which is a rarely visited by end users) There is no way to know which languages are supported in code blocks. How do we determine that this is an issue? The best way to determine if this s an issue is to see the usage of language specification as a percentage of usage of code blocks. [Insights > Code sharing in Teams Desktop (interana.com)](https://teams.interana.com/insights/b4622) (As of 5/1) Currently Language specification is in R3 and telemetry for language specification is recently implemented and now flowing. Soon we will have data to backup this hypothesis that language specification is an issue Customer/business problem addressed (Why)? This is part of Project Unicorn's effort to make the product more compelling for developers, digital natives and slack holdouts. The current implementation of language specification of code blocks will deter the quick adoption. This feature will help improve the learning curve of language specification in code blocks What is the key result that this feature is expected to drive (Key Results)? Key Results to drive with this feature - Increase usage of language specification % of code blocks shared with language specification Reduce the reliance of code snippets for users to share code in Teams High Level Requirements are listed here - Req # Statement Pri 1 Code Block Discoverability 1.1 When user does ```ticks, there should be a way for the user to see or pick the languages supported P1 1.2 Introduce new button in format options for code block P1 1.3 When code block is invoked, the format options should show code block selected. P1 1.4 If the user clicked on the Format options button entry point of code block to initiate the code block, the user should have an option to pick the language specified. P1 1.5 User can change the language in the code block at any time P2 Here are some examples for design inspiration- Language drop down on triple back tick - Image 2. Once the language is specified, it is shown to the user as they type out their code. (This is specifically beneficial when the user uses the button to invoke a code block) Image
anbahl34 commented 11 months ago

This is a comment on the issue

anbahl34 commented 11 months ago

New comment by Anuj