Skip to content

Commit af45d71

Browse files
docs: gif로 변경, 단어 선택 변경
1 parent cbf56f5 commit af45d71

File tree

1 file changed

+28
-20
lines changed

1 file changed

+28
-20
lines changed

README.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111

1212
<p align="center">
1313
<a href="#옥토독스소개">🐙 옥토독스 소개</a> <br>
14-
<a href="#주차별피드백">🌱 주차별 피드백을 통한 점진적 개선</a> <br>
14+
<a href="#주차별피드백">🏗️ 피드백을 반영한 점진적 개선</a> <br>
1515
<a href="#프로젝트타임라인">🗺️ 프로젝트 타임라인</a> <br>
16-
<a href="#프로젝트구조">🛠️ 프로젝트 구조</a> <br>
17-
<a href="#문제와해결과정">🚧 문제와 해결과정</a> <br>
18-
<a href="#팀원소개">🧸 팀원 소개</a> <br>
16+
<a href="#프로젝트구조">️ 프로젝트 구조</a> <br>
17+
<a href="#핵심경험">🗜️ 팀의 핵심 경험</a> <br>
18+
<a href="#팀원소개">🍻 팀원 소개</a> <br>
1919
</p>
2020

2121
<br><br>
@@ -31,29 +31,37 @@
3131
📢 마크다운, 이미지, 코드 등을 활용해서 간편하게 **문서 작성**이 가능합니다. <br>
3232
📢 작성한 문서들을 **연결**하고 **배치**하면서 새로운 아이디어를 쉽게 떠올릴 수 있습니다.
3333

34-
https://github.com/user-attachments/assets/1ac81d56-a0ce-403c-9e3f-7ba092b6a5b6
34+
![문서 작성과 연결 gif](https://raw.githubusercontent.com/summersummerwhy/gif/blob/main/391353713-1ac81d56-a0ce-403c-9e3f-7ba092b6a5b6-ezgif.com-video-to-gif-converter.gif)
3535

3636
<br>
3737

38-
### 👥 실시간 동시 편집 및 협업 기능
38+
### 👥 실시간 동시 편집 및 협업
3939

4040
📢 에디터에서 간편하게 **실시간 동시 편집**이 가능합니다. <br>
4141
📢 작성된 문서들도 **함께 연결하고 배치**해 보며 우리 팀만의 구조를 만들어 볼 수 있습니다.
4242

43-
https://github.com/user-attachments/assets/86b0dcaf-3640-4836-8b91-207b39b17b05
43+
![실시간 동시편집 gif](https://raw.githubusercontent.com/summersummerwhy/gif/blob/main/391975638-86b0dcaf-3640-4836-8b91-207b39b17b05-ezgif.com-video-to-gif-converter.gif)
4444

4545
<br>
4646

47-
### 📮 워크스페이스 초대 기능
47+
### 📮 워크스페이스 초대 가능
4848

4949
📢 우리 팀만의 **워크 스페이스를 생성**하고 팀원들을 **초대**할 수 있습니다. <br>
5050
📢 워크 스페이스의 **공개 범위**를 설정해서 누구나 참여할 수 있는 공간도 생성이 가능합니다.
5151

52-
https://github.com/user-attachments/assets/0c096e40-bed4-4cee-bb8e-40f72a5d43f2
52+
![워크스페이스 초대 gif](https://raw.githubusercontent.com/summersummerwhy/gif/blob/main/391998820-0c096e40-bed4-4cee-bb8e-40f72a5d43f2-ezgif.com-video-to-gif-converter.gif)
5353

54-
<br><br><br><br>
54+
<br>
55+
56+
<div align="center">
57+
<a href="https://octodocs.site/" target="_blank">
58+
➡️ 지금 옥토독스 사용해보러 가기!
59+
</a>
60+
</div>
61+
62+
<br><br>
5563

56-
<h1 id="피드백">🏗️ 피드백을 반영한 점진적 개선</h1>
64+
<h1 id="주차별피드백">🏗️ 피드백을 반영한 점진적 개선</h1>
5765

5866
<br>
5967

@@ -123,7 +131,7 @@ https://github.com/user-attachments/assets/0c096e40-bed4-4cee-bb8e-40f72a5d43f2
123131

124132
<br><br>
125133

126-
<h1 id="Octodocs 팀의 핵심 경험">🗜️ Octodocs 팀의 핵심 경험</h1>
134+
<h1 id="핵심경험">🗜️ Octodocs 팀의 핵심 경험</h1>
127135

128136
### 🗣️ 실시간 편집 구현 과정
129137

@@ -141,49 +149,49 @@ Octodocs 팀은 기존 RESTful API 기반 상태 관리를 버리고 **YDoc 중
141149

142150
<br>
143151

144-
### 🛠️ FE 프로젝트 구조 개선 과정
152+
### 🛠️ FE 프로젝트 구조 개선
145153

146154
짧은 기간의 스프린트를 빠르게 반복하여 개발했던 Octodocs 팀은 어느 순간부터 기능을 추가하고 유지보수하기 어렵다는 문제점을 마주하였습니다. 기존 **프로젝트 구조**의 문제점을 어떻게 파악했고, 어떤 방법으로 개선 했을까요?
147155

148156
[🔗 FSD, 힙하지만 막 갖다 쓰진 않았습니다](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/FE-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EA%B5%AC%EC%A1%B0-%EA%B0%9C%EC%84%A0-%EA%B3%BC%EC%A0%95)
149157

150158
<br>
151159

152-
### 🔑 워크스페이스 별 권한 부여 구현 과정
160+
### 🔑 워크스페이스 별 권한 부여
153161

154162
Octodocs 팀은 배포를 끝낸 사이트를 발표에 직접 이용하다가, 발표를 듣는 사용자들이 발표 자료를 멋대로 변경할 수도 있다는 걱정을 마주했고 **사용자들이 워크스페이스별 권한을 관리**할 수 있어야겠다는 결론을 내렸습니다. 하지만 워크스페이스에 초대를 하면 알림이 가는 시스템을 만들기에는 개발 기간이 얼마 남지 않은 상태였어요. Octodocs 팀은 어떻게 워크스페이스별 권한 관리를 구현하였을까요?
155163

156164
[🔗 발표 자료 워크스페이스 접근 금지](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/%EC%9B%8C%ED%81%AC%EC%8A%A4%ED%8E%98%EC%9D%B4%EC%8A%A4-%EA%B6%8C%ED%95%9C-%EC%84%A4%EA%B3%84%2C-%EA%B5%AC%ED%98%84-%EA%B3%BC%EC%A0%95)
157165

158166
<br>
159167

160-
### ✨ 드래그 이벤트 발생 시 생기는 쿼리 최적화
168+
### ✨ 드래그 이벤트 발생 시 쿼리 최적화
161169

162170
노트 카드를 **드래그할 때 너무 많은 쿼리가 발생**해 서버가 멈추는 치명적인 문제가 있었습니다. 핵심 기능인 캔버스를 아예 이용할 수 없었기에, 반드시 해결해야 하는 과제였습니다. Octodocs 팀은 소수점 단위로 변하는 좌표를 DB에 저장하기 위해 어떤 최적화를 도입했을까요?
163171

164172
[🔗 우측으로 1mm만 옮겨주세요](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/%EB%8D%B0%EC%9D%B4%ED%84%B0-%EA%B4%80%EC%B0%B0%2C-%EC%BF%BC%EB%A6%AC-%EB%B0%9C%EC%83%9D-%EC%B5%9C%EC%A0%81%ED%99%94-%EA%B3%BC%EC%A0%95)
165173

166174
<br>
167175

168-
### 🧨 Redis를 활용한 데이터베이스 부하 줄이기
176+
### 🧨 Redis를 활용해 데이터베이스 부하 줄이기
169177

170-
실시간으로 문서를 동시에 편집하면 굉장히 많은 변경 사항이 발생합니다. 누군가 타이핑을 할 때마다 변경 사항들을 모두 데이터베이스에 반영하기에는 부하가 너무 발생했기에, Octodocs 팀은 redis를 도입하기로 결정했습니다. 어떤 지점에서 redis 도입을 결정했고, 어떻게 redis를 활용하고 있을까요?
178+
실시간으로 문서를 동시에 편집하면 굉장히 많은 변경 사항이 발생합니다. 누군가 타이핑을 할 때마다 변경 사항들을 모두 데이터베이스에 반영하기에는 부하가 너무 발생했기에, Octodocs 팀은 **redis를 도입**하기로 결정했습니다. 어떤 지점에서 redis 도입을 결정했고, 어떻게 redis를 활용하고 있을까요?
171179

172180
[🔗 Redis 같은 걸 끼얹나?](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/redis%EB%A5%BC-%ED%86%B5%ED%95%B4-%EB%8D%B0%EC%9D%B4%ED%84%B0%EB%B2%A0%EC%9D%B4%EC%8A%A4-%EC%BF%BC%EB%A6%AC-%EC%A4%84%EC%9D%B4%EA%B8%B0)
173181

174182
<br>
175183

176-
### 🐳 개발 환경, 배포 환경 및 CI/CD에 대한 개선 과정
184+
### 🐳 개발 환경, 배포 환경 및 CI/CD 개선해나가기
177185

178-
Octodocs 팀은 사용자 경험 향상은 물론, 일관된 코드 품질 유지와 개발자 친화적인 쾌적한 개발 환경 조성을 위해 많은 노력을 기울였습니다. 멀티 레포에서 모노레포로의 전환, GitHub Actions를 활용한 CI/CD 구축, Docker와 Docker Compose의 도입까지—우리는 어떤 변화를 거쳤을까요?
186+
Octodocs 팀은 사용자 경험 향상은 물론, 일관된 코드 품질 유지와 **개발자 친화적인 쾌적한 개발 환경 조성** 위해 많은 노력을 기울였습니다. 멀티 레포에서 모노레포로의 전환, GitHub Actions를 활용한 CI/CD 구축, Docker와 Docker Compose의 도입까지—우리는 어떤 변화를 거쳤을까요?
179187

180188
[🔗 환경 개선의 여정 따라가기](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/%EA%B0%9C%EB%B0%9C-%ED%99%98%EA%B2%BD%2C-%EB%B0%B0%ED%8F%AC-%ED%99%98%EA%B2%BD-%EB%B0%8F-CI-CD%EC%97%90-%EB%8C%80%ED%95%9C-%EA%B0%9C%EC%84%A0-%EA%B3%BC%EC%A0%95)
181189

182190
<br><br>
183191

184192
<h1 id="프로젝트구조">⚙️ 프로젝트 구조</h1>
185193

186-
### 🖥️ System Architecture
194+
### System Architecture
187195

188196
![image (13)](https://github.com/user-attachments/assets/bee51119-c814-4f57-8cda-60ea4bfdd2dd)
189197

0 commit comments

Comments
 (0)